CLI

The CLI is a thin wrapper over the same Server Actions the dashboard uses. Anything you can do in the UI works from a terminal, and every read command supports --json so you can pipe results into scripts.

Install

shipeasy --version
shipeasy --help

See Authenticate for the login flow.

At a glance

shipeasy release flags list
shipeasy release configs list
shipeasy release killswitch list
shipeasy sdk keys list
shipeasy mcp install

Add --json to any read command for machine-readable output. Add --project <id> to override the active project for a single call.

Global flags

The CLI doesn't have process-wide global options today — each subcommand declares its own flags. Two flags are accepted by nearly every write command, though:

Env scoping is per-subcommand (e.g. configs draft --env staging) rather than a global --env flag.

Auth

Feature flags

--rules accepts a JSON array of { attr, op, value } rules — the same shape the dashboard produces:

shipeasy release flags create new-ui \
  --rollout-percent 25 \
  --rules '[{"attr":"plan","op":"eq","value":"pro"}]'

Killswitches (alias ks) — break-glass

shipeasy release ks create email.outbound
shipeasy release ks set email.outbound --switch-key off --value true

Dynamic values (configs)

Drafting and publishing a config per environment is dashboard-only — the CLI writes each environment directly with --dev / --staging / --prod.

shipeasy release configs update pricing --value '{"base":9.99,"currency":"USD"}'

Metrics

SDK keys

| Command | Description | | ------------------------------------------------- | --------------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------- | | shipeasy sdk keys list | List keys (id, kind, last used). The raw token is never shown after creation. | | shipeasy sdk keys create --type <server | client | admin> | Create a key (required: --type). Token is shown once. | | shipeasy sdk keys revoke <id> | Revoke by id or id-prefix. First match wins. |

API tokens

For long-lived CI access, create an admin SDK key from the dashboard's SDK Keys page (shipeasy sdk keys create --type admin) and pass it via the SHIPEASY_CLI_TOKEN env. See Authenticate → SDK keys vs API tokens for when to use each.

Feedback (bugs & requests)

ops bug takes the bug-report contract (--steps-to-reproduce, --actual-result, --expected-result); ops feature takes --description, --use-case, --importance. Both accept --json for scripting.

shipeasy ops bug "Checkout button overlaps footer" \
  --steps "1. Add item to cart. 2. Resize below 1024px." \
  --actual "Button hidden behind sticky footer" \
  --expected "Button stays visible above the footer"

shipeasy ops feature "Dark mode dashboard" \
  --description "System-prefers dark theme for the dashboard chrome" \
  --use-case "Reviewing the ops queue at night" \
  --importance important

MCP server

See MCP server for the tool inventory.

Agent skills & plugins

There is no separate skills or plugin install command — shipeasy setup does it. It detects every coding agent in your environment (Claude Code, Cursor, OpenAI Codex, GitHub Copilot, Google Jules) and wires each the way that agent expects: the Claude Code marketplace plugin (commands + skills + MCP) for Claude, and the agent's own instructions file (.cursor/rules/shipeasy.mdc, AGENTS.md, .github/copilot-instructions.md) plus @shipeasy/mcp registration for the rest.

shipeasy setup                              # detect + wire every agent found
shipeasy setup --yes --agents claude,cursor # non-interactive subset

setup is idempotent — re-run it as you add agents.

Environment variables

Exit codes

0 on success, 1 on any error. JSON output goes to stdout; human-readable progress goes to stderr — pipes work the way you'd expect.

shipeasy release flags list | jq '.[] | select(.enabled == true) | .name'

Examples

# Create a feature flag, set targeting, roll out to 5%, then promote to 100%.
shipeasy release flags create checkout-v2 --rules '[{"attr":"plan","op":"eq","value":"pro"}]'
shipeasy release flags update checkout-v2 --rollout-percent 5
shipeasy release flags update checkout-v2 --rollout-percent 100

# File a bug from CI when a smoke test fails.
SHIPEASY_CLI_TOKEN="$CI_TOKEN" shipeasy ops bug "Smoke test failed on deploy" \
  --steps-to-reproduce "See CI run" --priority high