Skip to main content

Installation

Requirements​

  • Node.js ^20.17.0 or ^22.13.0 or >=23.5.0
  • npm (or pnpm/yarn for local installs)

Global install​

npm install -g shipspec-cli

Verify:

ship-spec --version

Local install (per repo)​

npm install shipspec-cli --save-dev

Run with npx:

npx ship-spec --help

Initialize a project​

cd your-project
ship-spec init

What it does:

  • Prompts for OpenRouter/Tavily API keys
  • Stores keys in the OS keychain (per-project namespace)
  • Creates .ship-spec/ with outputs, planning artifacts, LanceDB, consent tracking
  • Updates .gitignore

Upgrading​

npm install -g shipspec-cli@latest
ship-spec --version