Synopsis

fcli fod report create [--delim=<delimiter>] --format=<format> [--notes=<notes>] --rel=id|app[:ms]:rel --template=id|name [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] ] [--store=_variableName[=<propertyNames>]] [--to-file=<outputFile>]] <reportName>

Description

This command allows a new report to be created for a release. To find the name or id of a report template to use, please use the "fod report list-templates" command.

Options

--delim=<delimiter>

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

--format=<format>

The format of the report to create. Valid values: pdf, html.

--notes=<notes>

Any additional notes to add to the report.

--rel, --release=id|app[:ms]:rel

Release id or <application>[:<microservice>]:<release> name.

--template=id|name

Report template name or id.

Session options:

--session=<sessionName>

Name of the FoD session to use for executing this command. Default value: default.

Output options:

-o, --output=format[=<options>]

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

--store=variableName[=<propertyNames>]

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

--to-file=<outputFile>

Write command output to the specified file instead of stdout.

Generic fcli options:

--env-prefix=<envPrefix>

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

-h, --help

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

--log-file=<logFile>

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

--log-level=<logLevel>

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

Arguments

<reportName>

The name of the report to create - this needs to be unique for the release.