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
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"
}]