Skip to content

CLI Output

The CLI supports two output modes:

  • default human-readable output
  • --json for structured output designed for scripts and agents

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 no data
  • error (string, optional) — present on failure
  • data (any, nullable) — command-specific payload

In JSON mode, the CLI suppresses any additional console output so parsers do not break.

On failure, the CLI uses non-zero exit codes so scripts can branch on error type:

  • 1 — generic error
  • 2 — authentication error
  • 3 — connection error

Most commands will return 1 on validation or configuration errors.