Skip to main content

Global Flags

The following flags are available on every shift-cli command and sub-command.

FlagDescription
--jsonOutput structured JSON instead of human-readable text
--quietSuppress all stdout; the command communicates results via exit code only
--helpShow help for the command
--versionShow the CLI version

Inheritance

All sub-commands inherit these flags. You can place them before or after the sub-command:

# These are equivalent
shift-cli --json yp services list
shift-cli yp services list --json

Output Mode Details

Human-readable (default)

Formatted, colorized output designed for interactive terminal use. Includes tables, progress indicators, and styled text.

JSON (--json)

Produces a single JSON object on stdout. Useful for piping into jq, scripting, or consumption by AI coding agents. The structure matches the gateway API response envelope:

{
"success": true,
"data": { ... }
}

Quiet (--quiet)

No output is written to stdout. The command result is communicated entirely through the exit code. Useful in CI pipelines and shell conditionals:

if shift-cli status --quiet; then
echo "Gateway is reachable"
fi