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>] [--log-mask=<logMaskLevel>] [--debug]] [[--fod-session=<sessionName>]] ] [--style=<outputStyleElements>_[, <outputStyleElements>…]]… ] [--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.
FoD session name options
- --fod-session=<sessionName>
-
Name of the FoD session to use for executing this command. Default value: default.
Output options
- -o, --output=type[=<args>]
-
Specify output type and optional type arguments. Available output formats: csv, table, expr, json, xml, yaml. 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.
- --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.
- --style=<outputStyleElements>[,<outputStyleElements>…]
-
Comma-separated list of style elements to apply to the selected output format. Allowed values: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border.
- --to-file=<outputFile>
-
Write command output to the specified file instead of stdout.
Generic fcli options
- --debug
-
Enable both fcli trace logging and collection of extra debugging data on applicable fcli actions and commands, for example enabling debug logging on tools invoked through fcli tool run commands, or enabling server-side debug log generation.
- --env-prefix=<envPrefix>
-
Environment variable prefix for resolving default option and parameter values. Default value: 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, NONE.
- --log-mask=<logMaskLevel>
-
Masking level to apply to logging data. Allowed values: high, medium, low, none. Default value: medium. Note that this is on a best-effort basis; you should always check log contents for sensitive data before sharing or publishing logs.