Output Formatting

By default, the CLI App will output its data in table format.

You can select the output format by using the --format option. For example, to specify that the output should be formatted in JSON format, use the option --format json.

Supported Formats

  • table (default)
  • table,interactive (searchable and scrollable)
  • table,dark
  • table,bright
  • table,light
  • table,markdown
  • json (human-readable)
  • json,raw (compact)
  • csv

Control Characters in Output

Values returned by the API, such as file names, can contain terminal escape sequences and other control characters. Table output always displays them as escaped text (for example \x1b for ESC) instead of sending them to the terminal as controls. CSV and text output are escaped the same way when written directly to a terminal; when redirected to a file or piped to another program, values are written exactly as returned by the API so exports stay lossless. Newline and tab characters keep their existing formatting and are not escaped. JSON output always escapes control characters as required by the JSON format; on a terminal the remaining DEL and C1 characters are shown as \uXXXX escapes as well, so terminal JSON stays valid and decodes to the same values, while redirected JSON keeps its exact bytes. Error messages and --debug=STDOUT logs are escaped the same way when written to a terminal.

files-cli users list --format=table,interactive

files-cli folders list-for /path/to/folder --format csv

files-cli folders create --path /path/to/folder/to/be/created --format=json,raw

files-cli users list --format=table,dark

Configuring the Default Format

You can configure a preferred format as the default for a profile.

files-cli config set --profile=interactive --format=table,interactive

Customizing Output

You can customize the output by specifying the fields to include in the response. Simply use the --fields option followed by a comma-separated list of the desired field names.

files-cli folders list-for --fields path,type --format json

Example output

[{
    "path": "document.docx",
    "type": "file"
},
{
    "path": "other",
    "type": "directory"
}]