Skip to main content

Global options

They apply to every command, before or after the resource name.

OptionsDescription
--params <JSON>Query/URL parameters as JSON
--json <JSON>Request body as JSON
--file <FIELD=PATH>File sent as a part of a multipart form, field=path (repeatable; --json fields become text parts)
--fields <FIELDS>Comma-separated list of fields to include in response
--dry-runShow the request without executing
--env <ENV>API environment: production, sandbox or development (each product has its own hosts). Can also be set via KOBANA_ENVIRONMENT.
--verboseShow request/response details on stderr
--output <PATH>Save response to file
--output-format <FORMAT>Output format: json (default), table, csv
--idempotency-key <KEY>Custom idempotency key for mutations
--page-allAuto-paginate and output NDJSON
--page-limit <N>Maximum pages to fetch (default: 10)
--page-delay <MS>Delay between pages in ms (default: 100)
--lang <LANG>Language of the messages: pt, en or es (default: KOBANA_LANG or the system's)
-h, --helpPrint help
-V, --versionPrint version