Spec Kitty is an open-source CLI workflow for spec-driven development with AI coding agents.
It helps teams turn product intent into implementation with a repeatable path:
spec -> plan -> tasks -> implement -> review -> merge.
AI coding workflows often break down on larger features:
- Requirements and design decisions drift over long agent sessions
- Parallel work is hard to coordinate across branches
- Review and acceptance criteria become inconsistent from one feature to the next
Spec Kitty addresses this with repository-native artifacts, work package workflows, and git worktree isolation.
- Project Owners who need explicit approval boundaries and outcome accountability
- External Tech Lead Evaluators assessing delivery predictability and adoption fit
- External Architect Evaluators evaluating governance durability and boundary clarity
- External Product Manager Evaluators validating intent-to-delivery traceability
- Lead Developers coordinating implementation quality and handoffs
- Maintainers preserving operational consistency across features and agents
| Stakeholder Persona | Value Proposition |
|---|---|
| Project Owner | Faster onboarding with explicit governance checkpoints and acceptance accountability |
| External Tech Lead Evaluator | Deterministic, auditable multi-agent workflow with clear lifecycle guardrails |
| External Architect Evaluator | C4 + ADR traceability with explicit host authority and integration boundaries |
| External Product Manager Evaluator | Clear intent-to-artifact mapping and lower handoff ambiguity between product and engineering |
| Lead Developer | Structured work package flow, quality gates, and review-ready evidence trails |
| Maintainer | Stable operational model with bounded external integrations and trackable state transitions |
Try it now: pip install spec-kitty-cli && spec-kitty init my-project --ai claude
| Capability | What Spec Kitty provides |
|---|---|
| Spec-driven artifacts | Generates and maintains spec.md, plan.md, and tasks.md in kitty-specs/<feature>/ |
| Work package execution | Uses canonical 2.x lifecycle lanes (planned, claimed, in_progress, for_review, done, blocked, canceled) with doing as UI alias for in_progress |
| Parallel implementation model | Creates isolated git worktrees under .worktrees/ for work package execution |
| Live project visibility | Local dashboard for kanban and feature progress (spec-kitty dashboard) |
| Acceptance + merge workflow | Built-in acceptance checks and merge helpers (spec-kitty accept, spec-kitty merge) |
| Multi-agent support | Template and command generation for 12 AI agent integrations |
Quick Start β’ Claude Code Guide β’ Live Dashboard β’ 12 AI Agents β’ Full Docs
graph LR
A[π Specify<br/>WHAT to build] --> B[π― Plan<br/>HOW to build]
B --> C[π Tasks<br/>Work packages]
C --> D[β‘ Implement<br/>Agent workflows]
D --> E[π Review<br/>Quality gates]
E --> F[π Merge<br/>Ship it]
style A fill:#e1f5ff
style B fill:#e1f5ff
style C fill:#fff3e0
style D fill:#f3e5f5
style E fill:#e8f5e9
style F fill:#fce4ec
Current stable release line: v2.1.1 (main, GitHub Releases, and PyPI)
2.1.1 highlights:
- Hotfix for PyPI wheels to bundle the canonical doctrine skill pack correctly
- Upgrade repair migration for
2.1.0projects that missed the managed skill pack - Release guardrails now fail if a wheel omits doctrine files or bundled skills
2.1.0 highlights:
- Agent Skills Pack with bundled skills, installer/verification flow, and upgrade migration coverage
- Structured requirement mapping from requirements into work-package planning
- Deterministic branch intent injection in planning templates
1.xis now deprecated and retained only as1.x-maintenancefor critical fixes
Jump to: Getting Started β’ Examples β’ 12 AI Tools β’ CLI Reference β’ Worktrees β’ Troubleshooting
Spec Kitty now uses main as the stable 2.x release line.
The former 1.x line is deprecated and moves to 1.x-maintenance for maintenance-only fixes.
| Branch | Version | Status | Install |
|---|---|---|---|
| main | 2.1.x | Current stable line | pip install spec-kitty-cli |
| 1.x-maintenance | 1.x | Deprecated, maintenance-only | Install from a pinned maintenance tag or source checkout |
For users: install the stable line from PyPI with pip install spec-kitty-cli.
For existing 1.x users: migrate to 2.1.x where possible; 1.x-maintenance is only for critical maintenance and will no longer publish new PyPI releases.
Run multi-agent delivery with an external orchestrator while keeping workflow state and guardrails in spec-kitty. Core CLI orchestration is exposed as spec-kitty orchestrator-api; there is no in-core spec-kitty orchestrate shim.
# Verify host contract
spec-kitty orchestrator-api contract-version --json
# Use the reference external orchestrator
spec-kitty-orchestrator orchestrate --feature 034-my-feature --dry-run
spec-kitty-orchestrator orchestrate --feature 034-my-featureDocs:
- External provider runbook:
docs/how-to/run-external-orchestrator.md - Custom provider guide:
docs/how-to/build-custom-orchestrator.md
sequenceDiagram
participant Lead as π¨βπΌ Lead Architect
participant Claude as π€ Claude (Spec)
participant Cursor as π€ Cursor (Impl)
participant Gemini as π€ Gemini (Review)
participant Dashboard as π Live Kanban
Lead->>Claude: /spec-kitty.specify
Claude->>Dashboard: WP01-WP05 (planned)
par Parallel Work
Lead->>Cursor: implement WP01
Lead->>Cursor: implement WP02
end
Cursor->>Dashboard: WP01 β in_progress (Doing)
Cursor->>Dashboard: WP01 β for_review
Lead->>Gemini: /spec-kitty.review WP01
Gemini->>Dashboard: WP01 β done
Note over Dashboard: Real-time updates<br/>No branch switching
Key Benefits:
- π Parallel execution - Multiple WPs simultaneously
- π³ Worktree isolation - One workspace per WP to reduce branch contention
- π Full visibility - Dashboard shows who's doing what
- π Security boundary - Orchestration policy and transitions are validated at the host API boundary
Spec Kitty includes a live dashboard that automatically tracks your feature development progress. View your kanban board, monitor work package status, and see which agents are working on whatβall updating in real-time as you work.
The dashboard starts automatically when you run spec-kitty init and runs in the background. Access it anytime with the /spec-kitty.dashboard command or spec-kitty dashboardβthe CLI will start the correct project dashboard automatically if it isn't already running, let you request a specific port with --port, or stop it cleanly with --kill.
Key Features:
- π Kanban Board: Visual workflow across canonical lifecycle lanes (including
blockedandcanceled) withDoingrendered asin_progress - π Progress Tracking: Real-time completion percentages and task counts
- π₯ Multi-Agent Support: See which AI agents are working on which tasks
- π¦ Artifact Status: Track specification, plan, tasks, and other deliverables
- π Live Updates: Dashboard refreshes automatically as you work
Work packages flow through automated quality gates using the canonical 2.x lifecycle FSM. Agents move tasks between lanes, and the dashboard tracks state transitions in real-time.
stateDiagram-v2
[*] --> planned
planned --> claimed
claimed --> in_progress
in_progress --> for_review
for_review --> done
for_review --> in_progress: changes requested
for_review --> planned: replan
planned --> blocked
claimed --> blocked
in_progress --> blocked
for_review --> blocked
blocked --> in_progress
planned --> canceled
claimed --> canceled
in_progress --> canceled
for_review --> canceled
blocked --> canceled
Lane terminology follows the glossary: see
glossary/contexts/orchestration.md#lane.
New to Spec Kitty? Here's the complete lifecycle from zero to shipping features:
# 1. Install the CLI
pip install spec-kitty-cli
# or
uv tool install spec-kitty-cli
# 2. Initialize your project
spec-kitty init my-project --ai claude
# 3. Verify setup (optional)
cd my-project
spec-kitty verify-setup # Checks that everything is configured correctly
# 4. View your dashboard
spec-kitty dashboard # Opens http://localhost:3000-5000What just happened:
- β
Created
.claude/commands/(or.gemini/,.cursor/, etc.) with 13 slash commands - β
Created
.kittify/directory with scripts, templates, and mission configuration - β Started real-time kanban dashboard (runs in background)
- β
Initialized git repository with proper
.gitignore
Important: If you've upgraded
spec-kitty-clivia pip/uv, runspec-kitty upgradein each of your projects to apply structural migrations.
cd your-project
spec-kitty upgrade # Upgrade to current versionThe upgrade command automatically migrates your project structure across versions:
| Version | Migration |
|---|---|
| 0.10.9 | Repair broken templates with bash script references (#62, #63, #64) |
| 0.10.8 | Move memory/ and AGENTS.md to .kittify/ |
| 0.10.6 | Simplify implement/review templates to use workflow commands |
| 0.10.2 | Update slash commands to Python CLI and flat structure |
| 0.10.0 | Remove bash scripts, migrate to Python CLI |
| 0.9.1 | Complete lane migration + normalize frontmatter |
| 0.9.0 | Flatten task lanes to frontmatter-only (no directory-based lanes) |
| 0.8.0 | Remove active-mission (missions now per-feature) |
| 0.7.3 | Update scripts for worktree feature numbering |
| 0.6.7 | Ensure software-dev and research missions present |
| 0.6.5 | Rename commands/ β command-templates/ |
| 0.5.0 | Install encoding validation git hooks |
| 0.4.8 | Add all 12 AI agent tooling directories to .gitignore |
| 0.2.0 | Rename .specify/ β .kittify/ and /specs/ β /kitty-specs/ |
Run
spec-kitty upgrade --verboseto see which migrations apply to your project.
# Preview changes without applying
spec-kitty upgrade --dry-run
# Show detailed migration information
spec-kitty upgrade --verbose
# Upgrade to specific version
spec-kitty upgrade --target 0.6.5
# Skip worktree upgrades (main project only)
spec-kitty upgrade --no-worktrees
# JSON output for CI/CD integration
spec-kitty upgrade --jsonRun spec-kitty upgrade after:
- Installing a new version of
spec-kitty-cli - Cloning a project that was created with an older version
- Seeing "Unknown mission" or missing slash commands
The upgrade command is idempotent - safe to run multiple times. It automatically detects your project's version and applies only the necessary migrations.
# Launch your chosen AI coding agent
claude # For Claude Code
# or
gemini # For Gemini CLI
# or
code # For GitHub Copilot / CursorVerify slash commands loaded:
Type /spec-kitty and you should see autocomplete with all 13 commands.
Still in main repo - Start with your project's governing principles:
/spec-kitty.constitution
Create principles focused on code quality, testing standards,
user experience consistency, and performance requirements.
What this creates:
.kittify/memory/constitution.md- Your project's architectural DNA- These principles will guide all subsequent development
- Missions do not have separate constitutions; the project constitution is the single source of truth
Now begin the feature development cycle:
/spec-kitty.specify
Build a user authentication system with email/password login,
password reset, and session management. Users should be able to
register, login, logout, and recover forgotten passwords.
What this does:
- Creates
kitty-specs/001-auth-system/spec.mdwith user stories - Enters discovery interview - Answer questions before continuing!
- All planning happens in the main repo (worktrees created later during implementation)
/spec-kitty.plan
Use Python FastAPI for backend, PostgreSQL for database,
JWT tokens for sessions, bcrypt for password hashing,
SendGrid for email delivery.
What this creates:
kitty-specs/001-auth-system/plan.md- Technical architecturekitty-specs/001-auth-system/data-model.md- Database schemakitty-specs/001-auth-system/contracts/- API specifications- Enters planning interview - Answer architecture questions!
/spec-kitty.research
Investigate best practices for password reset token expiration,
JWT refresh token rotation, and rate limiting for auth endpoints.
What this creates:
kitty-specs/001-auth-system/research.md- Research findings- Evidence logs for decisions made
/spec-kitty.tasks
What this creates:
kitty-specs/001-auth-system/tasks.md- Kanban checklistkitty-specs/001-auth-system/tasks/WP01.md- Work package prompts (flat structure)- Up to 10 work packages ready for implementation
Check your dashboard: You'll now see tasks in the planned lane.
/spec-kitty.implement
What this does:
- Auto-detects first WP with
lane: "planned"(or specify WP ID) - Automatically advances toward
lane: "in_progress"(displayed as "Doing") and shows the prompt - Shows clear "WHEN YOU'RE DONE" instructions
- Agent implements, then runs command to move to
lane: "for_review"
Repeat until all work packages are done!
/spec-kitty.review
What this does:
- Auto-detects first WP with
lane: "for_review"(or specify WP ID) - Moves review execution to
lane: "in_progress"(displayed as "Doing") and shows the prompt - Agent reviews code and provides feedback or approval
- Shows commands to move to
lane: "done"(passed) orlane: "planned"(changes needed)
/spec-kitty.accept
What this does:
- Verifies all WPs have
lane: "done" - Checks metadata and activity logs
- Confirms no
NEEDS CLARIFICATIONmarkers remain - Records acceptance timestamp
/spec-kitty.merge --push
What this does:
- Switches to main branch
- Merges feature branch
- Pushes to remote (if
--pushspecified) - Cleans up worktree
- Deletes feature branch
π Feature complete! Return to main repo and start your next feature with /spec-kitty.specify
1οΈβ£ /spec-kitty.constitution β In main repo (sets project principles)
2οΈβ£ /spec-kitty.specify β Create spec (in main repo)
3οΈβ£ /spec-kitty.plan β Define technical approach (in main repo)
4οΈβ£ /spec-kitty.tasks β Generate work packages (in main repo)
5οΈβ£ spec-kitty implement WP01 β Create workspace for WP01 (first worktree)
/spec-kitty.implement β Build the work package
6οΈβ£ /spec-kitty.review β Review completed work
7οΈβ£ /spec-kitty.accept β Validate feature ready
8οΈβ£ /spec-kitty.merge β Merge to main + cleanup
/spec-kitty.research β After /plan: Investigate technical decisions
/spec-kitty.analyze β After /tasks: Cross-artifact consistency check
/spec-kitty.checklist β Anytime: Generate custom quality checklists
/spec-kitty.dashboard β Anytime: Open/restart the kanban dashboard
Important: Agent directories (.claude/, .codex/, .gemini/, etc.) should NEVER be committed to git.
These directories may contain:
- Authentication tokens and API keys
- User-specific credentials (auth.json)
- Session data and conversation history
Spec Kitty automatically protects you with multiple layers:
During spec-kitty init:
- β
Adds all 12 agent directories to
.gitignore - β
Creates
.claudeignoreto optimize AI scanning (excludes.kittify/templates)
Worktree Constitution Sharing: When creating WP workspaces, Spec Kitty uses symlinks to share the constitution:
.worktrees/001-feature-WP01/.kittify/memory -> ../../../../.kittify/memory
This ensures all work packages follow the same project principles.
β DO commit:
.kittify/templates/- Command templates (source).kittify/missions/- Mission workflows.kittify/memory/constitution.md- Project principles.gitignore- Protection rules
β NEVER commit:
.claude/,.gemini/,.cursor/, etc. - Agent runtime directories- Any
auth.jsonor credentials files
See AGENTS.md for complete guidelines.
Spec Kitty differentiates between the project that holds your entire codebase, the features you build within that project, and the mission that defines your workflow. Use these definitions whenever you write docs, prompts, or help text.
For glossary-first terminology (including semantic-integrity rules), see glossary/README.md.
Definition: The entire codebase (one Git repository) that contains all missions, features, and .kittify/ automation.
Examples:
- "spec-kitty project" (this repository)
- "priivacy_rust project"
- "my-agency-portal project"
Usage: Projects are initialized once with spec-kitty init. A project contains:
- One active mission at a time
- Multiple features (each with its own spec/plan/tasks)
- Shared automation under
.kittify/
Commands: Initialize with spec-kitty init for the current directory by default (or pass spec-kitty init my-project to create a project directory).
Definition: A single unit of work tracked by Spec Kitty. Every feature has its own spec, plan, tasks, and implementation worktree.
Examples:
- "001-auth-system feature"
- "005-refactor-mission-system feature" (this document)
- "042-dashboard-refresh feature"
Structure:
- Specification:
/kitty-specs/###-feature-name/spec.md - Plan:
/kitty-specs/###-feature-name/plan.md - Tasks:
/kitty-specs/###-feature-name/tasks.md - Implementation:
.worktrees/###-feature-name/
Lifecycle:
/spec-kitty.specifyβ Create the feature and its branch/spec-kitty.planβ Document the technical design/spec-kitty.tasksβ Break work into packages/spec-kitty.implementβ Build the feature inside its worktree/spec-kitty.reviewβ Peer review/spec-kitty.acceptβ Validate according to gates/spec-kitty.mergeβ Merge and clean up
Commands: Always create features with /spec-kitty.specify.
Compatibility note: In current 2.x, feature slugs remain the practical artifact key for kitty-specs/ and worktrees.
Definition: A domain adapter that configures Spec Kitty (workflows, templates, validation). Missions are project-wide; all features in a project share the same active mission.
Examples:
- "software-dev mission" (ship software with TDD)
- "research mission" (conduct systematic investigations)
- "writing mission" (future workflow)
What missions define:
- Workflow phases (e.g., design β implement vs. question β gather findings)
- Templates (spec, plan, tasks, prompts)
- Validation rules (tests pass vs. citations documented)
- Path conventions (e.g.,
src/vs.research/)
Scope: Entire project. In current 2.x, mission is selected at init and remains fixed for the project lifecycle.
Runtime note: Mission-run identity (mission_id / mission_run_id) is the preferred runtime collaboration scope when available.
Commands:
- Select at init:
spec-kitty init my-project --mission research - Inspect:
spec-kitty mission current/spec-kitty mission list
| Term | Scope | Example | Key Command |
|---|---|---|---|
| Project | Entire codebase | "spec-kitty project" | spec-kitty init my-project |
| Feature | Unit of work | "001-auth-system feature" | /spec-kitty.specify "auth system" |
| Mission | Workflow adapter | "research mission" | spec-kitty init --mission research |
Q: What's the difference between a project and a feature?
A project is your entire git repository. A feature is one unit of work inside that project with its own spec/plan/tasks.
Q: Can I have multiple missions in one project?
Only one mission is active at a time in current 2.x. Select it during spec-kitty init.
Q: Should I create a new project for every feature?
No. Initialize a project once, then create as many features as you need with /spec-kitty.specify.
Q: What's a task? Tasks (T001, T002, etc.) are subtasks within a feature's work packages. They are not separate features or projects.
Learn from real-world workflows used by teams building production software with AI agents. Each playbook demonstrates specific coordination patterns and best practices:
-
Multi-Agent Feature Development Coordinate 3-5 AI agents on a single large feature using an external orchestrator plus host API
-
Parallel Implementation Tracking Monitor multiple teams/agents delivering features simultaneously with dashboard metrics
-
Dashboard-Driven Development Product trio workflow: PM + Designer + Engineers using live kanban visibility
-
Claude + Cursor Collaboration Blend different AI agents within a single spec-driven workflow
Browse our examples directory for additional workflows including:
- Agency client transparency workflows
- Solo developer productivity patterns
- Enterprise parallel development
- Research mission templates
| Tool | Support | Notes |
|---|---|---|
| Claude Code | β | |
| GitHub Copilot | β | |
| Gemini CLI | β | |
| Cursor | β | |
| Qwen Code | β | |
| opencode | β | |
| Windsurf | β | |
| Kilo Code | β | |
| Auggie CLI | β | |
| Roo Code | β | |
| Codex CLI | β | |
| Amazon Q Developer CLI | Amazon Q Developer CLI does not support custom arguments for slash commands. |
The spec-kitty command supports the following options. Every run begins with a discovery interview, so be prepared to answer follow-up questions before files are touched.
| Command | Description |
|---|---|
init |
Initialize a new Spec Kitty project from templates |
upgrade |
Upgrade project structure to current version (run after updating spec-kitty-cli) |
repair |
Repair broken template installations (fixes bash script references from v0.10.0-0.10.8) |
accept |
Validate feature readiness before merging to main |
check |
Check that required tooling is available |
dashboard |
Open or stop the Spec Kitty dashboard |
diagnostics |
Show project health and diagnostics information |
merge |
Merge a completed feature branch into main and clean up resources |
orchestrator-api |
Host contract for external orchestrators (JSON envelope interface) |
research |
Execute Phase 0 research workflow to scaffold artifacts |
verify-setup |
Verify that the current environment matches Spec Kitty expectations |
| Argument/Option | Type | Description |
|---|---|---|
<project-name> |
Argument | Name for your new project directory (omit to initialize in the current directory, same as --here) |
--ai |
Option | AI assistant to use: claude, gemini, copilot, cursor, qwen, opencode, codex, windsurf, kilocode, auggie, roo, or q |
--script |
Option | (Deprecated in v0.10.0) Script variant - all commands now use Python CLI |
--mission |
Option | Mission key to seed templates (software-dev, research, ...) |
--template-root |
Option | Override template location (useful for development mode or custom sources) |
--ignore-agent-tools |
Flag | Skip checks for AI agent tools like Claude Code |
--no-git |
Flag | Skip git repository initialization |
--here |
Flag | Initialize project in the current directory instead of creating a new one |
--force |
Flag | Force merge/overwrite when initializing in current directory (skip confirmation) |
--skip-tls |
Flag | Skip SSL/TLS verification (not recommended) |
--debug |
Flag | Enable detailed debug output for troubleshooting |
--github-token |
Option | GitHub token for API requests (or set GH_TOKEN/GITHUB_TOKEN env variable) |
If you omit --mission, the CLI will prompt you to pick one during spec-kitty init.
# Basic initialization in current directory (default)
spec-kitty init --ai claude
# Basic project initialization in a new directory
spec-kitty init my-project
# Initialize with specific AI assistant
spec-kitty init my-project --ai claude
# Initialize with the Deep Research mission
spec-kitty init my-project --mission research
# Initialize with Cursor support
spec-kitty init my-project --ai cursor
# Initialize with Windsurf support
spec-kitty init my-project --ai windsurf
# Initialize with PowerShell scripts (Windows/cross-platform)
spec-kitty init my-project --ai copilot --script ps
# Initialize in current directory
spec-kitty init . --ai copilot
# or use the --here flag
spec-kitty init --here --ai copilot
# Force merge into current (non-empty) directory without confirmation
spec-kitty init . --force --ai copilot
# or
spec-kitty init --here --force --ai copilot
# Skip git initialization
spec-kitty init my-project --ai gemini --no-git
# Enable debug output for troubleshooting
spec-kitty init my-project --ai claude --debug
# Use GitHub token for API requests (helpful for corporate environments)
spec-kitty init my-project --ai claude --github-token ghp_your_token_here
# Use custom template location (development mode)
spec-kitty init my-project --ai claude --template-root=/path/to/local/spec-kitty
# Check system requirements
spec-kitty check| Option | Description |
|---|---|
--dry-run |
Preview changes without applying them |
--force |
Skip confirmation prompts |
--target <version> |
Target version to upgrade to (defaults to current CLI version) |
--json |
Output results as JSON (for CI/CD integration) |
--verbose, -v |
Show detailed migration information |
--no-worktrees |
Skip upgrading worktrees (main project only) |
Examples:
# Upgrade to current version
spec-kitty upgrade
# Preview what would be changed
spec-kitty upgrade --dry-run
# Upgrade with detailed output
spec-kitty upgrade --verbose
# Upgrade to specific version
spec-kitty upgrade --target 0.6.5
# JSON output for scripting
spec-kitty upgrade --json
# Skip worktree upgrades
spec-kitty upgrade --no-worktreesThe spec-kitty agent namespace provides programmatic access to all workflow automation commands. All commands support --json output for agent consumption.
Feature Management:
spec-kitty agent feature create-feature <name>β Create new feature with worktreespec-kitty agent feature check-prerequisitesβ Validate project setup and feature contextspec-kitty agent feature setup-planβ Initialize plan template for featurespec-kitty agent context updateβ Update agent context filesspec-kitty agent feature acceptβ Run acceptance workflowspec-kitty agent feature mergeβ Merge feature branch and cleanup
Task Workflow:
spec-kitty agent workflow implement <id> --agent __AGENT__β Advance planned/claimed β in_progress β for_review automaticallyspec-kitty agent workflow review <id> --agent __AGENT__β Advance for_review β in_progress β planned/done automaticallyspec-kitty agent tasks list-tasksβ List all tasks grouped by lanespec-kitty agent tasks mark-status <id> --status <status>β Mark task statusspec-kitty agent tasks add-history <id> --note <message>β Add activity log entryspec-kitty agent tasks validate-workflow <id>β Validate task metadata
Workflow Commands:
spec-kitty agent workflow implement [WP_ID] --agent __AGENT__β Display WP prompt and auto-move toin_progress("Doing")spec-kitty agent workflow review [WP_ID] --agent __AGENT__β Display WP prompt for review and auto-move toin_progress("Doing")
Note: In generated agent command files, __AGENT__ is replaced at init time with the agent key (e.g., codex, claude). If you run commands manually, replace __AGENT__ with your agent name.
Example Usage:
# Create feature (agent-friendly)
spec-kitty agent feature create-feature "Payment Flow" --json
# Display WP prompt and auto-move to in_progress ("Doing")
spec-kitty agent workflow implement WP01 --agent __AGENT__
# Run workflow to advance lanes
spec-kitty agent workflow implement WP01 --agent __AGENT__
# Validate workflow
spec-kitty agent tasks validate-workflow WP01 --json
# Accept feature
spec-kitty agent feature accept --json| Option | Description |
|---|---|
--port <number> |
Preferred port for the dashboard (falls back to first available port) |
--kill |
Stop the running dashboard for this project and clear its metadata |
Examples:
# Open dashboard (auto-detects port)
spec-kitty dashboard
# Open on specific port
spec-kitty dashboard --port 4000
# Stop dashboard
spec-kitty dashboard --kill| Option | Description |
|---|---|
--feature <slug> |
Feature slug to accept (auto-detected by default) |
--mode <mode> |
Acceptance mode: auto, pr, local, or checklist (default: auto) |
--actor <name> |
Name to record as the acceptance actor |
--test <command> |
Validation command to execute (repeatable) |
--json |
Emit JSON instead of formatted text |
--lenient |
Skip strict metadata validation |
--no-commit |
Skip auto-commit; report only |
--allow-fail |
Return checklist even when issues remain |
Examples:
# Validate feature (auto-detect)
spec-kitty accept
# Validate specific feature
spec-kitty accept --feature 001-auth-system
# Get checklist only (no commit)
spec-kitty accept --mode checklist
# Accept with custom test validation
spec-kitty accept --test "pytest tests/" --test "npm run lint"
# JSON output for CI integration
spec-kitty accept --json| Option | Description |
|---|---|
--strategy <type> |
Merge strategy: merge, squash, or rebase (default: merge) |
--delete-branch / --keep-branch |
Delete or keep feature branch after merge (default: delete) |
--remove-worktree / --keep-worktree |
Remove or keep feature worktree after merge (default: remove) |
--push |
Push to origin after merge |
--target <branch> |
Target branch to merge into (default: main) |
--dry-run |
Show what would be done without executing |
Examples:
# Standard merge and push
spec-kitty merge --push
# Squash commits into one
spec-kitty merge --strategy squash --push
# Keep branch for reference
spec-kitty merge --keep-branch --push
# Preview merge without executing
spec-kitty merge --dry-run
# Merge to different target
spec-kitty merge --target develop --pushVerifies that the current environment matches Spec Kitty expectations:
- Checks for
.kittify/directory structure - Validates agent command files exist
- Confirms dashboard can start
- Reports any configuration issues
Example:
cd my-project
spec-kitty verify-setupShows project health and diagnostics information:
- Active mission
- Available features
- Dashboard status
- Git configuration
- Agent command availability
Example:
spec-kitty diagnosticsAfter running spec-kitty init, your AI coding agent will have access to these slash commands for structured development.
π Quick Reference: See the command order flowchart above for a visual workflow guide.
Workflow sequence for spec-driven development:
| # | Command | Description |
|---|---|---|
| 1 | /spec-kitty.constitution |
(First in main repo) Create or update project governing principles and development guidelines |
| 2 | /spec-kitty.specify |
Define what you want to build (requirements and user stories; creates worktree) |
| 3 | /spec-kitty.plan |
Create technical implementation plans with your chosen tech stack |
| 4 | /spec-kitty.research |
Run Phase 0 research scaffolding to populate research.md, data-model.md, and evidence logs |
| 5 | /spec-kitty.tasks |
Generate actionable task lists and work package prompts in flat tasks/ directory |
| 6 | /spec-kitty.implement |
Display WP prompt, auto-move to in_progress ("Doing"), show completion instructions |
| 7 | /spec-kitty.review |
Display WP prompt for review, auto-move to in_progress ("Doing"), show next steps |
| 8 | /spec-kitty.accept |
Run final acceptance checks, record metadata, and verify feature complete |
| 9 | /spec-kitty.merge |
Merge feature into main branch and clean up worktree |
Optional commands for enhanced quality and development:
| Command | When to Use |
|---|---|
/spec-kitty.analyze |
Optional, after /spec-kitty.tasks, before /spec-kitty.implement: Cross-artifact consistency & coverage analysis |
/spec-kitty.checklist |
Optional, anytime after /spec-kitty.plan: Generate custom quality checklists that validate requirements completeness, clarity, and consistency |
/spec-kitty.dashboard |
Anytime (runs in background): Open the real-time kanban dashboard in your browser. Automatically starts with spec-kitty init and updates as you work. |
π Quick Start: See the Getting Started guide for practical examples of worktree usage in context.
Spec Kitty uses an opinionated worktree approach for parallel feature development:
graph TD
Main[main branch<br/>π Clean production code]
WT1[.worktrees/001-auth-WP01<br/>π Authentication]
WT2[.worktrees/001-auth-WP02<br/>πΎ Database]
WT3[.worktrees/002-dashboard-WP01<br/>π UI Components]
Main --> WT1
Main --> WT2
Main --> WT3
WT1 -.->|π Parallel work| WT2
WT2 -.->|β
No conflicts| WT3
style Main fill:#e8f5e9
style WT1 fill:#e1f5ff
style WT2 fill:#fff3e0
style WT3 fill:#f3e5f5
Why this works:
- Each WP gets its own directory + branch
- Work on Feature 001 WP01 while another agent handles Feature 002 WP01
- Main branch stays clean - no
git checkoutjuggling - Merge conflicts detected early with pre-flight validation
my-project/ # Main repo (main branch)
βββ .worktrees/
β βββ 001-auth-system-WP01/ # Feature 1 WP01 (isolated sandbox)
β βββ 001-auth-system-WP02/ # Feature 1 WP02 (parallel work)
β βββ 002-dashboard-WP01/ # Feature 2 WP01 (different feature)
βββ .kittify/
βββ kitty-specs/
βββ ... (main branch files)
- Main branch stays in the primary repo root
- Feature branches live in
.worktrees/<feature-slug>/ - Work on features happens in their worktrees (complete isolation)
- No branch switching in main repo - just
cdbetween worktrees - Automatic cleanup - worktrees removed after merge
# ========== IN MAIN REPO ==========
/spec-kitty.constitution # Step 1: Establish project governance (one time per project)
# ========== CREATE FEATURE BRANCH & WORKTREE ==========
/spec-kitty.specify # Step 2: Creates feature branch + isolated worktree
cd .worktrees/001-my-feature # Enter isolated sandbox for feature development
# ========== IN FEATURE WORKTREE ==========
/spec-kitty.plan # Step 3: Design technical implementation
/spec-kitty.research # Step 4 (as needed): Research technologies, patterns, etc.
/spec-kitty.tasks # Step 5: Break plan into actionable tasks
/spec-kitty.analyze # Step 6 (optional): Check cross-artifact consistency
/spec-kitty.implement # Step 7: Execute implementation tasks
/spec-kitty.review # Step 8: Review and refine completed work
/spec-kitty.accept # Step 9: Acceptance checks & final metadata
/spec-kitty.merge --push # Step 10: Merge to main + cleanup worktree
# ========== BACK IN MAIN REPO ==========
# Ready for next feature!Spec Kitty supports missions: curated bundles of templates, commands, and guardrails for different domains. Two missions ship out of the box:
- Software Dev Kitty β the original Spec-Driven Development workflow for shipping application features (default).
- Deep Research Kitty β a methodology-focused workflow for evidence gathering, analysis, and synthesis.
Each mission lives under .kittify/missions/<mission-key>/ and provides:
- Mission-specific templates (
spec-template.md,plan-template.md,tasks-template.md, etc.) - Command guidance tuned to the domain (
specify,plan,tasks,implement,review,accept) - Optional constitutions to bias the agent toward best practices
Choose your mission during initialization:
# Select mission interactively
spec-kitty init my-project --ai claude
# Or specify mission directly
spec-kitty init my-project --ai claude --mission software-dev
spec-kitty init research-project --ai claude --mission researchAfter initialization, mission selection is recorded in project metadata:
# View active mission
spec-kitty mission current
# Project metadata
cat .kittify/metadata.yamlNote: In current 2.x, missions are selected during spec-kitty init and remain active for the project lifecycle.
| Variable | Description |
|---|---|
SPECIFY_FEATURE |
Override feature detection for non-Git repositories. Set to the feature directory name (e.g., 001-photo-albums) to work on a specific feature when not using Git branches.**Must be set in the context of the agent you're working with prior to using /spec-kitty.plan or follow-up commands. |
SPEC_KITTY_TEMPLATE_ROOT |
Optional. Point to a local checkout whose templates/, scripts/, and memory/ directories should seed new projects (handy while developing Spec Kitty itself). |
SPECIFY_TEMPLATE_REPO |
Optional. Override the GitHub repository slug (owner/name) to fetch templates from when you explicitly want a remote source. |
CODEX_HOME |
Required when using the Codex CLI so it loads project-specific prompts. Point it to your projectβs .codex/ directoryβset it manually with export CODEX_HOME=\"$(pwd)/.codex\" or automate it via direnv on Linux/macOS/WSL. |
- Linux/macOS (or WSL2 on Windows)
- AI coding agent: Claude Code, GitHub Copilot, Gemini CLI, Cursor, Qwen CLI, opencode, Codex CLI, Windsurf, or Amazon Q Developer CLI
- uv for package management
- Python 3.11+
- Git
If you encounter issues with an agent, please open an issue so we can refine the integration.
The stable 2.x line now lives on main and publishes from semantic tags in the form v2.<minor>.<patch>.
Starting with 2.1.0, the release workflow publishes both GitHub release artifacts and the PyPI package.
- Configure PyPI Trusted Publishing for
spec-kitty-cliagainst.github/workflows/release.yml. - Keep
1.x-maintenancemaintenance-only; do not use it for new PyPI releases.
git checkout main
git pull origin main
git checkout -b release/vX.Y.Z
# Update pyproject.toml to a semantic version (example: X.Y.Z)
# Add CHANGELOG.md entry under: ## [X.Y.Z] - YYYY-MM-DDpython scripts/release/validate_release.py --mode branch --tag-pattern "v2.*.*"
python -m pytest
python -m build
twine check dist/*
rm -rf dist/ build/git add pyproject.toml CHANGELOG.md
git commit -m "chore(release): prepare X.Y.Z"
git push origin release/vX.Y.ZAfter review, merge into main with a linear-history strategy (rebase).
git checkout main
git pull origin main
git tag vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.ZThis triggers .github/workflows/release.yml.
gh release view vX.Y.Z
python -m pip index versions spec-kitty-clirelease-readiness.yml: runs on PRs tomain(and2.xduring the cutover window) to validate version/changelog/tests.release.yml: runs onv2.*.*tags and performs:- test execution
- release metadata validation
- artifact build and checksums
- PyPI publication via Trusted Publishing
- GitHub Release creation with changelog notes
Validation fails: "Version does not advance beyond latest tag"
- Check latest tag:
git tag --list 'v2.*.*' --sort=-version:refname | head -1 - Bump
pyproject.tomlto a higher semantic version
Validation fails: "CHANGELOG.md lacks a populated section"
- Add
## [X.Y.Z]with release notes inCHANGELOG.md
Tag already exists:
git tag -d vX.Y.Z
git push origin :refs/tags/vX.Y.Z
git tag vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.ZRELEASE_CHECKLIST.mddocs/how-to/2-1-main-cutover-checklist.mdscripts/release/README.md.github/workflows/release.yml
- Complete Spec-Driven Development Methodology - Deep dive into the full process
- Getting Started Guide - Step-by-step walkthrough from installation to feature completion
If you're contributing to Spec Kitty or working with the source code directly, you'll need to install it in development mode:
# Clone the repository
git clone https://github.com/Priivacy-ai/spec-kitty.git
cd spec-kitty
# Install in editable mode with development dependencies
pip install -e ".[test]"
# When running spec-kitty init, set the template root to your local checkout:
export SPEC_KITTY_TEMPLATE_ROOT=$(pwd)
spec-kitty init <PROJECT_NAME> --ai=claude
# Or use the --template-root flag directly (no env var needed):
spec-kitty init <PROJECT_NAME> --ai=claude --template-root=/path/to/spec-kittyThe CLI searches for templates in this order:
- Command-line override:
--template-rootflag (highest priority) - Environment variable:
SPEC_KITTY_TEMPLATE_ROOT(local checkout) - Packaged resources: Built-in templates from PyPI installation
- Remote repository:
SPECIFY_TEMPLATE_REPOenvironment variable
This means development installs automatically find templates when running from the cloned repository, but you may need to set SPEC_KITTY_TEMPLATE_ROOT if you move the directory.
This error occurs when spec-kitty init cannot locate the template files. Here's how to diagnose and fix it:
For PyPI installations:
# Reinstall the package
pip install --upgrade spec-kitty-cli
# Verify templates are bundled
python -c "from importlib.resources import files; print(files('specify_cli').joinpath('templates'))"For development installations:
# Make sure you installed in editable mode from the repo root
cd /path/to/spec-kitty
pip install -e .
# Option 1: Use environment variable
export SPEC_KITTY_TEMPLATE_ROOT=$(pwd)
spec-kitty init my-project --ai=claude
# Option 2: Use --template-root flag (no env var needed)
spec-kitty init my-project --ai=claude --template-root=$(pwd)
# Option 3: Verify the path exists
ls -la ./templates/commandsFor moved repositories: If you cloned the spec-kitty repo and moved the directory, update the environment variable:
export SPEC_KITTY_TEMPLATE_ROOT=/new/path/to/spec-kitty
spec-kitty init my-project --ai=claudeDebugging with verbose output:
# Use --debug flag to see which paths were checked
spec-kitty init my-project --ai=claude --debug --template-root=/path/to/spec-kittyIf you're having issues with Git authentication on Linux, you can install Git Credential Manager:
#!/usr/bin/env bash
set -e
echo "Downloading Git Credential Manager v2.6.1..."
wget https://github.com/git-ecosystem/git-credential-manager/releases/download/v2.6.1/gcm-linux_amd64.2.6.1.deb
echo "Installing Git Credential Manager..."
sudo dpkg -i gcm-linux_amd64.2.6.1.deb
echo "Configuring Git to use GCM..."
git config --global credential.helper manager
echo "Cleaning up..."
rm gcm-linux_amd64.2.6.1.deb- Robert Douglass (@robertDouglass)
For support, please open a GitHub issue. We welcome bug reports, feature requests, and questions about using Spec-Driven Development.
This project is heavily influenced by and based on the work and research of John Lam.
This project is licensed under the terms of the MIT open source license. Please refer to the LICENSE file for the full terms.


