Skip to main content
Every command picks its output format from the terminal and the global flags. On a terminal you get a readable table or key-value list. Anywhere else, and whenever a format flag is set, you get machine readable output. When more than one flag is set the precedence is --toon, then --quiet, then --json, then the default.

​
Pretty output

Lists print as a table, single resources as a key-value list, and both end with breadcrumbs suggesting the command to run next:

​
JSON envelope

data holds the resource or the array of resources. breadcrumbs is left out when a command has none, and pagination appears only on list commands.

​
Quiet output

--quiet drops the envelope and prints the payload alone. For commands that create or update a resource it prints just the identifier, and for delete it prints success. That makes it the right choice inside a shell pipeline:

​
TOON output

--toon emits TOON, a token optimized encoding of the same data. It carries the same fields as the JSON envelope in noticeably fewer tokens, which matters when the output is going into an AI assistant’s context window.

​
Pagination

List commands take --page and --page-size, with a maximum page size of 100. The pagination block reports current_page_number, total_pages, total_records, and page_size, so a script can keep incrementing --page until it reaches total_pages.