Output Formats

Every CLI command supports three output formats. Choose the right one for your use case.

The --format flag

Use --format to switch between output modes:

shipchart projects list --format text   # default
shipchart projects list --format json
shipchart projects list --format llm

Shorthand flags are also available:

shipchart projects list --json
shipchart projects list --llm

Text (default)

Human-readable, formatted output designed for terminal use. Includes colors, tables, and visual hierarchy.

$ shipchart projects list

  NAME          STAGE      REVENUE
  Shipchart     growing    £1,200
  DogTracker         launched   £350
  SideProject   building   £0

Best for: interactive terminal sessions, quick checks, day-to-day usage.

JSON

Machine-readable JSON output. Returns the raw API response data, perfect for scripting and piping to other tools.

$ shipchart projects list --json

[
  {
    "id": "01JDEF1234ABCDE",
    "name": "Shipchart",
    "stage": "growing",
    "revenue_this_month": 1200
  },
  {
    "id": "01JDEF5678FGHIJ",
    "name": "DogTracker",
    "stage": "launched",
    "revenue_this_month": 350
  }
]

Best for: shell scripts, piping to jq, CI/CD pipelines, programmatic access.

LLM

Compact markdown optimized for LLM consumption. Structured enough for AI agents to parse, concise enough to fit in context windows.

$ shipchart projects list --llm

# Projects (3)
- **Shipchart** (growing) — Revenue: £1,200
- **DogTracker** (launched) — Revenue: £350
- **SideProject** (building) — Revenue: £0

Best for: feeding output to AI assistants, providing context in prompts, agent workflows.

Piping and scripting

Combine --json with standard Unix tools:

# Get all project names
shipchart projects list --json | jq -r ".[].name"

# Copy dashboard to clipboard
shipchart dashboard --llm | pbcopy

# Get this month's revenue for a specific project
shipchart projects show my-saas --json | jq ".revenue_this_month"

# Export analytics for a Slack post
shipchart analytics export --period 2026-03

Commands Reference

Every command with flags and examples

Shell Completions

Tab completion for bash, zsh, and fish