Command flags

Flags can be used to define some generic command behavior, or to specify output from each command. To set the default value for each flag, use the SET command. Flags are appended after a command and its arguments. Below is a list of available flags:

-format

Output format. Possible values: csv, table. Default value: csv (in command-line mode), table (in shell mode).

-delim

Delimiter for the CSV output. If used with the argument "", the system delimiter will be used (which is also the default value). If a system delimiter is not set, ',' is used. Since semicolon is used as the command separator, use quotation marks to specify it as a delimiter. Default value: "" (system delimiter, ',' if not set).

-out

Redirects output to a file. See also -mode and -enc flags. If used with the argument "", redirection will be disabled (which is also the default behavior). Default value: "" (redirection disabled).

-mode

File output mode. Possible values: o (overwrite the file), a (append to the end of the file). Default value: o (overwrite the file).

-enc

File output encoding. Possible values: ansi, utf8, utf16. Default value: utf8.

-header

Table header type. Possible values: keyword (use keywords as used in the show command arguments, for example, client_name), pretty (use more readable, translatable column names, for example Client Name), none (header is not shown). Default value: keyword.

-paged

Paged output. If enabled, the user is prompted to press a key after each page. Possible values: true, false. Default value: false.

-tableclip

Clip tables to fit the screen. This is applied only when outputting a table to a console window. Possible values: true, false. Default value: true.

-color

Use multiple colors when displaying content in the console window. Possible values: true, false. Default value: true.

-field

Table field formatting style. Possible values: keyword (use constant keywords, for example, finished_with_warning), pretty (use more readable, translatable texts, for example, "Finished with warning"). Default value: keyword.

-onerror

What to do if an error occurs while executing a command. If stop is set, the execution of a command sequence stops immediately. If continue is set, the execution continues with the following commands. The whole sequence ends with an error status if any commands have failed.  Possible values: stop, continue. Default value: stop.