@shipfoundry/cli
v0.2.2
Published
Manage ShipFoundry projects, recommendations, briefs and outcomes from your terminal.
Readme
ShipFoundry CLI
Manage projects, recommendations, briefs and outcomes from your terminal or an agent workflow. Requires Node.js 22 or newer. No runtime dependencies.
Install
Install the public package:
npm install -g @shipfoundry/cli
shipfoundry --helpThe installed CLI works without the ShipFoundry application source tree.
Read the CLI guide for commands and the agent setup guide for onboarding.
Configuration
Precedence: explicit option, environment, then non-secret profile. A base URL is required; there is no default production destination.
SHIPFOUNDRY_API_KEY(canonical) or legacySHIPFOUNDRY_MCP_TOKEN. The legacy variable name grants nothing extra: its value must be a key with explicit Developer API resource permission. Old MCP-only keys and MCP OAuth tokens do not work with the API.SHIPFOUNDRY_BASE_URL,--base-url, profilebaseUrlin~/.config/shipfoundry/config.json(base URL only, never secrets), required. There is no default production destination.- Plain HTTP is allowed only for loopback development endpoints. Credential-bearing redirects are refused.
Key setup is dashboard-bootstrapped; run shipfoundry auth login for the path. The CLI never mints keys and never persists secrets.
Output and exits
--jsonemits structured data on stdout; progress and diagnostics go to stderr.- Reads never prompt. Every write requires
--yes; nothing hangs on a TTY prompt. --wait(briefs request, operations wait) is bounded; on timeout or interruption the operation ID is reported so another process can resume.- Idempotency keys are preserved across retries: pass
--idempotency-keyexplicitly for automation. - Exits: 0 ok, 2 usage, 3 auth, 4 forbidden, 5 not found, 6 conflict, 7 quota/rate-limit, 8 transient, 9 wait timeout.
Linear templates
Version 0.2.0 adds linear templates, linear template-options,
linear preview-template, linear save-template, linear select-template
and linear manage-template. The field catalog, six built-in formats,
destinations and lifecycle requests are documented at
https://shipfoundry.ai/docs/linear-templates. Draft preview writes nothing;
save, select and management commands require --yes.
License
MIT. The license covers this CLI package only. It does not license the ShipFoundry hosted service or application repository.
