CLI commands, JSON, and exit codes

Use this page as the command map before scripting the CLI. The source of truth is the live apex schema --json command.

Global behavior

• apex is the canonical binary. drip is a compatibility alias.
• --json is available globally and on every registered command.
• Piped stdout automatically uses JSON mode even when --json is omitted.
• Human progress, prompts, diagnostics, and update notices go to stderr.
• Do not parse human tables. Use apex schema --json to discover commands and flags.

JSON output uses this stable top-level envelope:

{
  "ok": true,
  "version": "0.1.1",
  "command": "apex experiments list",
  "data": {}
}

Errors use the same envelope shape with ok: false and an error object:

{
  "ok": false,
  "version": "0.1.1",
  "command": "apex experiments apply",
  "error": {
    "message": "Applying these changes invalidates QA approval and requires confirmation.",
    "code": 4,
    "details": {
      "retry": "apex experiments apply ./my-test --force"
    }
  }
}

Headless and agent usage

DRIP_API_KEY=apx_your_key_here apex schema --json
apex experiments plan ./my-test --json
apex experiments apply ./my-test --json

In headless mode:

• Do not wait for prompts.
• Prefer explicit --json.
• If a command returns exit code 4, inspect error.details.retry and rerun with the exact flag only after checking the planned destructive or QA-invalidating action.
• Never commit ~/.drip/credentials.json, API keys, or preview tokens.

Exit codes

Command index

The command names in this index are checked against apex schema --json by the CLI CI lane.

Related pages

• Install and authenticate the Apex CLI
• Experiment lifecycle commands
• Agent tools: SOS, brand, schema, and skills