Getting Started with Ship Spec
Ship Spec is an AI-powered, spec-driven CLI that plans features, productionalizes prototypes, and produces agent-ready task prompts for coding agents.
Quick Start (3 steps)
- Install
npm install -g shipspec-cli
- Initialize
cd your-project
ship-spec init
Stores API keys securely in your OS keychain and creates the .ship-spec/ workspace.
- Run
# Plan a feature with PRD + Tech Spec + tasks
ship-spec planning "Add OAuth authentication" --cloud-ok
# Production readiness analysis
ship-spec productionalize "B2B SaaS handling PII" --enable-scans --cloud-ok
What you get
- Agent-ready task prompts to hand off to your coding agent (Cursor, Copilot, etc.)
- PRDs and Tech Specs generated with human-in-the-loop approvals
- Production Readiness Reports across security, SOC 2, code quality, dependencies, testing, config
- Optional SAST (Semgrep, Gitleaks, Trivy) and web research for compliance standards
Artifacts are written to .ship-spec/ (planning outputs and readiness reports).