Working with Resources¶
This page covers how to list, view, and create resources with the CLI.
Output Formats¶
Control how output is displayed with the --output-format (or -f) option.
Table (Default for Lists)¶
Human-readable table format, ideal for interactive use:
JSON¶
Machine-readable JSON, ideal for scripting and piping to jq:
YAML¶
YAML output, useful for configuration files:
CSV¶
Comma-separated values for spreadsheets and data analysis:
Markdown¶
Markdown table format, useful for documentation:
Pagination¶
List commands return paginated results. By default, only the first page is shown.
Page Size¶
Control how many items per page with --page-size:
Fetch All Pages¶
Use --all-pages to fetch all results (with a progress indicator):
Manual Pagination¶
For page-based endpoints, use --page to fetch a specific page:
Output Columns¶
Control which columns appear in table, CSV, and Markdown output.
Default Columns¶
By default, the CLI shows the most commonly needed columns:
All Columns¶
Use --output-columns all to show all available columns:
Specific Columns¶
Specify exactly which columns to display:
Truncation¶
By default, long values are truncated in table, CSV, and Markdown output. Use --no-truncate to show full values:
Full Export¶
For complete data export, combine --all-pages, --output-columns all, and --no-truncate:
Timestamps¶
Control how timestamps are displayed with --timestamp-format.
Relative (Default)¶
Shows time relative to now:
ISO 8601¶
Shows full ISO 8601 timestamps:
Input Methods¶
Commands that create or update resources accept input in several ways.
From a File¶
Create a JSON or YAML file with your resource definition (workspace.json):
Then use --input-file to read from it:
From Stdin¶
Use --input-file - to read from stdin. This is useful for piping data from other commands:
Inline Data¶
Use --input-data to provide JSON or YAML directly on the command line:
CLI Options¶
Many fields can be set directly as command options:
Combining Methods¶
You can combine a base file with CLI options. CLI options override values from the file: