CLI Output
The CLI supports two output modes:
- default human-readable output
--jsonfor structured output designed for scripts and agents
JSON output (--json)
Section titled “JSON output (--json)”When you pass --json, the CLI prints a single JSON object to stdout with this shape:
success(boolean)message(string, optional) — present on success when there is nodataerror(string, optional) — present on failuredata(any, nullable) — command-specific payload
In JSON mode, the CLI suppresses any additional console output so parsers do not break.
Exit codes
Section titled “Exit codes”On failure, the CLI uses non-zero exit codes so scripts can branch on error type:
1— generic error2— authentication error3— connection error
Most commands will return 1 on validation or configuration errors.