Skip to main content
Four output modes are available on every command. They are selected with the global flags --json, --quiet, and --toon. Precedence when more than one is set: --toon > --quiet > --json > pretty.

Pretty

The default when standard output is a terminal. Arrays render as aligned tables, objects as key-value pairs, and related commands are appended as breadcrumbs.
Column choice, column order, and truncation all adapt to the terminal width, so pretty output is meant for humans to read. Do not parse it. Use --json or --toon for anything that consumes the output programmatically.

JSON envelope

Used automatically when output is piped or redirected, and forced on a terminal with --json.
breadcrumbs is omitted when empty. pagination is present only on list commands that paginate.

Quiet

--quiet drops the envelope and emits the payload alone. On action commands it prints just the identifier, which is what makes it useful in a pipeline.
delete commands print success in quiet mode.

TOON

--toon emits Token-Optimized Output Notation: the same data as JSON with keys and whitespace compressed, typically 30 to 60 percent fewer tokens. Prefer it when piping list or show output into an AI assistant.
Parse it by reading keys the way you would with JSON.

Pagination

List commands that paginate accept --page (1-indexed) and --page-size (maximum 100). The envelope’s pagination object always exposes current_page_number, total_pages, and total_records.
To walk every page, increment --page until current_page_number equals total_pages.

Exit codes and errors

Every command exits non-zero on failure and writes a single line to standard error. See Troubleshooting for the common messages.