OpenSpec

OpenSpec

Spec-driven development for AI coding assistants.

Stars: 195

Visit
 screenshot

OpenSpec is a tool for spec-driven development, aligning humans and AI coding assistants to agree on what to build before any code is written. It adds a lightweight specification workflow that ensures deterministic, reviewable outputs without the need for API keys. With OpenSpec, stakeholders can draft change proposals, review and align with AI assistants, implement tasks based on agreed specs, and archive completed changes for merging back into the source-of-truth specs. It works seamlessly with existing AI tools, offering shared visibility into proposed, active, or archived work.

README:

OpenSpec logo

Spec-driven development for AI coding assistants.

CI npm version node version License: MIT Conventional Commits Discord

OpenSpec dashboard preview

Follow @0xTab on X for updates · Join the OpenSpec Discord for help and questions.

OpenSpec

OpenSpec aligns humans and AI coding assistants with spec-driven development so you agree on what to build before any code is written. No API keys required.

Why OpenSpec?

AI coding assistants are powerful but unpredictable when requirements live in chat history. OpenSpec adds a lightweight specification workflow that locks intent before implementation, giving you deterministic, reviewable outputs.

Key outcomes:

  • Human and AI stakeholders agree on specs before work begins.
  • Structured change folders (proposals, tasks, and spec updates) keep scope explicit and auditable.
  • Shared visibility into what's proposed, active, or archived.
  • Works with the AI tools you already use: custom slash commands where supported, context rules everywhere else.

How It Works

┌────────────────────┐
│ Draft Change       │
│ Proposal           │
└────────┬───────────┘
         │ share intent with your AI
         ▼
┌────────────────────┐
│ Review & Align     │
│ (edit specs/tasks) │◀──── feedback loop ──────┐
└────────┬───────────┘                          │
         │ approved plan                        │
         ▼                                      │
┌────────────────────┐                          │
│ Implement Tasks    │──────────────────────────┘
│ (AI writes code)   │
└────────┬───────────┘
         │ ship the change
         ▼
┌────────────────────┐
│ Archive & Update   │
│ Specs (source)     │
└────────────────────┘

1. Draft a change proposal that captures the spec updates you want.
2. Review the proposal with your AI assistant until everyone agrees.
3. Implement tasks that reference the agreed specs.
4. Archive the change to merge the approved updates back into the source-of-truth specs.

Getting Started

Supported AI Tools

Native Slash Commands

These tools have built-in OpenSpec commands. Select the OpenSpec integration when prompted.

Tool Commands
Claude Code /openspec:proposal, /openspec:apply, /openspec:archive
Cursor /openspec-proposal, /openspec-apply, /openspec-archive
OpenCode /openspec-proposal, /openspec-apply, /openspec-archive

AGENTS.md Compatible

These tools automatically read workflow instructions from openspec/AGENTS.md. Ask them to follow the OpenSpec workflow if they need a reminder. Learn more about the AGENTS.md convention.

Tools
Codex • Amp • Jules • Gemini CLI • GitHub Copilot • Others

Install & Initialize

Prerequisites

  • Node.js >= 20.19.0 - Check your version with node --version

Step 1: Install the CLI globally

npm install -g @fission-ai/openspec@latest

Verify installation:

openspec --version

Step 2: Initialize OpenSpec in your project

Navigate to your project directory:

cd my-project

Run the initialization:

openspec init

What happens during initialization:

  • You'll be prompted to select your AI tool (Claude Code, Cursor, etc.)
  • OpenSpec automatically configures slash commands or AGENTS.md based on your selection
  • A new openspec/ directory structure is created in your project

After setup:

  • Primary AI tools can trigger /openspec workflows without additional configuration
  • Run openspec list to verify the setup and view any active changes

Create Your First Change

Here's a real example showing the complete OpenSpec workflow. This works with any AI tool. Those with native slash commands will recognize the shortcuts automatically.

1. Draft the Proposal

Start by asking your AI to create a change proposal:

You: Create an OpenSpec change proposal for adding profile search filters by role and team
     (Shortcut for tools with slash commands: /openspec:proposal Add profile search filters)

AI:  I'll create an OpenSpec change proposal for profile filters.
     *Scaffolds openspec/changes/add-profile-filters/ with proposal.md, tasks.md, spec deltas.*

2. Verify & Review

Check that the change was created correctly and review the proposal:

$ openspec list                             # Confirm the change folder exists
$ openspec validate add-profile-filters     # Validate spec formatting
$ openspec show add-profile-filters         # Review proposal, tasks, and spec delta

3. Refine the Specs

Iterate on the specifications until they match your needs:

You: Can you add acceptance criteria for the role and team filters?

AI:  I'll update the spec delta with scenarios for role and team filters.
     *Edits openspec/changes/add-profile-filters/specs/profile/spec.md and tasks.md.*

4. Implement the Change

Once specs look good, start implementation:

You: The specs look good. Let's implement this change.
     (Shortcut for tools with slash commands: /openspec:apply add-profile-filters)

AI:  I'll work through the tasks in the add-profile-filters change.
     *Implements tasks from openspec/changes/add-profile-filters/tasks.md*
     *Marks tasks complete: Task 1.1 ✓, Task 1.2 ✓, Task 2.1 ✓...*

5. Archive the Completed Change

After implementation is complete, archive the change:

AI:  All tasks are complete. The implementation is ready.

You: Please archive the change
     (Shortcut for tools with slash commands: /openspec:archive add-profile-filters)

AI:  I'll archive the add-profile-filters change.
     *Runs: openspec archive add-profile-filters*
     ✓ Change archived successfully. Specs updated. Ready for the next feature!

Or run the command yourself in terminal:

$ openspec archive add-profile-filters  # Archive the completed change

Note: Tools with native slash commands (Claude Code, Cursor) can use the shortcuts shown. All other tools work with natural language requests to "create an OpenSpec proposal", "apply the OpenSpec change", or "archive the change".

Command Reference

openspec list               # View active change folders
openspec view               # Interactive dashboard of specs and changes
openspec show <change>      # Display change details (proposal, tasks, spec updates)
openspec validate <change>  # Check spec formatting and structure
openspec archive <change>   # Move a completed change into archive/

Example: How AI Creates OpenSpec Files

When you ask your AI assistant to "add two-factor authentication", it creates:

openspec/
├── specs/
│   └── auth/
│       └── spec.md           # Current auth spec (if exists)
└── changes/
    └── add-2fa/              # AI creates this entire structure
        ├── proposal.md       # Why and what changes
        ├── tasks.md          # Implementation checklist
        ├── design.md         # Technical decisions (optional)
        └── specs/
            └── auth/
                └── spec.md   # Delta showing additions

AI-Generated Spec (created in openspec/specs/auth/spec.md):

# Auth Specification

## Purpose
Authentication and session management.

## Requirements
### Requirement: User Authentication
The system SHALL issue a JWT on successful login.

#### Scenario: Valid credentials
- WHEN a user submits valid credentials
- THEN a JWT is returned

AI-Generated Change Delta (created in openspec/changes/add-2fa/specs/auth/spec.md):

# Delta for Auth

## ADDED Requirements
### Requirement: Two-Factor Authentication
The system MUST require a second factor during login.

#### Scenario: OTP required
- WHEN a user submits valid credentials
- THEN an OTP challenge is required

AI-Generated Tasks (created in openspec/changes/add-2fa/tasks.md):

## 1. Database Setup
- [ ] 1.1 Add OTP secret column to users table
- [ ] 1.2 Create OTP verification logs table

## 2. Backend Implementation  
- [ ] 2.1 Add OTP generation endpoint
- [ ] 2.2 Modify login flow to require OTP
- [ ] 2.3 Add OTP verification endpoint

## 3. Frontend Updates
- [ ] 3.1 Create OTP input component
- [ ] 3.2 Update login flow UI

Important: You don't create these files manually. Your AI assistant generates them based on your requirements and the existing codebase.

Understanding OpenSpec Files

Delta Format

Deltas are "patches" that show how specs change:

  • ## ADDED Requirements - New capabilities
  • ## MODIFIED Requirements - Changed behavior (include complete updated text)
  • ## REMOVED Requirements - Deprecated features

Format requirements:

  • Use ### Requirement: <name> for headers
  • Every requirement needs at least one #### Scenario: block
  • Use SHALL/MUST in requirement text

How OpenSpec Compares

vs. Kiro.dev

OpenSpec groups every change for a feature in one folder (openspec/changes/feature-name/), making it easy to track related specs, tasks, and designs together. Kiro spreads updates across multiple spec folders, which can make feature tracking harder.

vs. No Specs

Without specs, AI coding assistants generate code from vague prompts, often missing requirements or adding unwanted features. OpenSpec brings predictability by agreeing on the desired behavior before any code is written.

Team Adoption

  1. Initialize OpenSpec – Run openspec init in your repo.
  2. Start with new features – Ask your AI to capture upcoming work as change proposals.
  3. Grow incrementally – Each change archives into living specs that document your system.
  4. Stay flexible – Different teammates can use Claude Code, Cursor, or any AGENTS.md-compatible tool while sharing the same specs.

Run openspec update whenever someone switches tools so your agents pick up the latest instructions and slash-command bindings.

Updating OpenSpec

  1. Upgrade the package
    npm install -g @fission-ai/openspec@latest
  2. Refresh agent instructions
    • Run openspec update inside each project to regenerate AI guidance and ensure the latest slash commands are active.

Contributing

  • Install dependencies: pnpm install
  • Build: pnpm run build
  • Test: pnpm test
  • Develop CLI locally: pnpm run dev or pnpm run dev:cli
  • Conventional commits (one-line): type(scope): subject

License

MIT

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for OpenSpec

Similar Open Source Tools

For similar tasks

For similar jobs