OpenSpec README

The project's README from github.com/Fission-AI/OpenSpec. As one markdown file: README.md.

OpenSpec logo

CI npm version License: MIT Discord

The most loved spec framework.

Stars Downloads Contributors

Our philosophy:
→ fluid not rigid
→ iterative not waterfall
→ easy not complex
→ built for brownfield not just greenfield
→ scalable from personal projects to enterprises

[!TIP] New workflow now available! We've rebuilt OpenSpec with a new artifact-guided workflow.

Run /opsx:propose "your idea" to get started. → Learn more here

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

See it in action

You: /opsx:explore
AI:  What would you like to explore?
You: I want dark mode but I'm not sure how to do it cleanly.
AI:  Let me look at your styling setup...
     Cleanest path here: CSS variables + a small theme context,
     with system-preference detection. No new dependencies. Scope it?
You: Yes, let's do it.

You: /opsx:propose add-dark-mode
AI:  Created openspec/changes/add-dark-mode/
     ✓ proposal.md — why we're doing this, what's changing
     ✓ specs/       — requirements and scenarios
     ✓ design.md    — technical approach
     ✓ tasks.md     — implementation checklist
     Ready for implementation!

You: /opsx:apply
AI:  Implementing tasks...
     ✓ 1.1 Add theme context provider
     ✓ 1.2 Create toggle component
     ✓ 2.1 Add CSS variables
     ✓ 2.2 Wire up localStorage
     All tasks complete!

You: /opsx:archive
AI:  Archived to openspec/changes/archive/2025-01-23-add-dark-mode/
     Specs updated. Ready for the next feature.
What do the specs actually look like?

Plain Markdown — requirements with concrete scenarios, no special syntax to learn. Here's what goes in the specs/ folder created above:

## ADDED Requirements

### Requirement: Theme selection
The app SHALL let users switch between light and dark themes,
defaulting to the system preference.

#### Scenario: User toggles dark mode
- **WHEN** the user clicks the theme toggle
- **THEN** the app switches to dark mode and persists the choice

Your AI writes these; you review the plan before any code is written.

OpenSpec is built with OpenSpec — browse this repo's live specs and in-flight changes for real examples at scale.

OpenSpec Dashboard

OpenSpec dashboard preview

Why teams adopt OpenSpec

Solo, OpenSpec keeps you and your AI honest on a single repo. On a team, the hard part moves: a feature spans the API server, the web app, and a shared library; requirements are owned by one team and consumed by others; planning starts before any code exists.

Stores are the answer — planning in a repo of its own. The same openspec/ shape you already know (specs and changes), shared by git push like anything else. One source of truth your whole team and every coding agent can read, across every repo.

Stores are in beta. Start with the Stores User Guide.

Quick Start

Requires Node.js 20.19.0 or higher.

Install OpenSpec globally:

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

Then navigate to your project directory and initialize:

cd your-project
openspec init

Want your AI to do it? Paste the setup prompt into your coding assistant — it installs the CLI, runs openspec init, and verifies the result.

Now talk to your AI:

Both are in the default profile. If you want the expanded workflow (/opsx:new, /opsx:continue, /opsx:ff, /opsx:verify, /opsx:bulk-archive, /opsx:onboard), select it with openspec config profile and apply with openspec update.

/opsx:propose is the canonical name; your tool may spell it /opsx-propose (Cursor, GitHub Copilot), @opsx-propose (Amazon Q) or $openspec-propose (Codex). openspec init prints the right form for the tools you picked — see How To Invoke.

[!NOTE] Not sure if your tool is supported? View the full list – we support 30+ tools and growing.

Also works with pnpm, yarn, bun, and nix. See installation options.

Docs

Start here: the Documentation Home maps everything. New to OpenSpec? Read Getting Started, then How Commands Work (where you actually type /opsx:propose).

→ Getting Started: first steps
→ Explore First: think it through with /opsx:explore before you commit
→ How Commands Work: where slash commands run vs the CLI
→ Core Concepts at a Glance: the whole mental model, one page
→ Examples & Recipes: real changes, start to finish
→ Workflows: combos and patterns
→ Existing Projects: adopt OpenSpec on a brownfield codebase
→ Editing a Change: update artifacts, go back, reconcile manual edits
→ Commands: slash commands & skills
→ CLI: terminal reference
→ Stores: plan in a separate repo, shared across your team (beta)
→ Supported Tools: tool integrations & install paths
→ Concepts: how it all fits
→ Multi-Language: multi-language support
→ Customization: make it yours
→ Community Showcase: projects and resources built with and for OpenSpec
→ FAQ · Troubleshooting · Glossary: quick help

Community schemas

Third-party schema bundles distributed via standalone repositories — these provide opinionated workflows that integrate OpenSpec with other tools, similar to how github/spec-kit's community extension catalog handles tool integrations.

→ Browse the catalog in the customization docs.

Why OpenSpec?

AI coding assistants are powerful but unpredictable when requirements live only in chat history. OpenSpec adds a lightweight spec layer so you agree on what to build before any code is written.

How we compare

vs. Spec Kit (GitHub) — Thorough but heavyweight. Rigid phase gates, lots of Markdown, Python setup. OpenSpec is lighter and lets you iterate freely.

vs. Kiro (AWS) — Powerful but you're locked into their IDE and limited to Claude models. OpenSpec works with the tools you already use.

vs. nothing — AI coding without specs means vague prompts and unpredictable results. OpenSpec brings predictability without the ceremony.

Updating OpenSpec

Upgrade the package

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

Refresh agent instructions

Run this inside each project to regenerate AI guidance and ensure the latest slash commands are active:

openspec update

Usage Notes

Model selection: OpenSpec works best with high-reasoning models. We recommend Codex 5.5 and Opus 4.7 for both planning and implementation.

Context hygiene: OpenSpec benefits from a clean context window. Clear your context before starting implementation and maintain good context hygiene throughout your session.

Contributing

Open a discussion (for core design changes) or an issue before you open a PR, and link the issue or discussion from the PR. New features, significant refactors, and architectural changes need an OpenSpec change proposal first.

→ CONTRIBUTING.md: the full process, from first issue to merged PR

Other

Telemetry

OpenSpec collects anonymous usage stats.

We collect only command names and version to understand usage patterns. No arguments, paths, content, or PII. Automatically disabled in CI.

Opt-out (any one is enough):

  • openspec config set telemetry.enabled false (global config; unset means on)
  • export OPENSPEC_TELEMETRY=0 or export DO_NOT_TRACK=1 (env overrides config)
Maintainers & Advisors

See MAINTAINERS.md for the list of core maintainers and advisors who help guide the project.

License

MIT

OpenSpec (Fission-AI/OpenSpec)

Searching Database…

72.3K ·GitHub
这是什么?OpenSpec 是一个规范驱动的开发工具,它增加了一层轻量的规范,让你和你的 AI 编程助手在编写任何代码之前就需求达成一致。
这是框架还是 CLI 工具?它是一个 Node.js 命令行工具,外加一组 AI 编程助手会调用的斜杠命令和技能;规范本身是纯 Markdown 文件,存放在你代码仓库中的 openspec/ 文件夹里。
怎么把它跑起来?全局安装 OpenSpec,然后在项目目录中运行 'openspec init' 完成设置;或者把提供的设置提示词粘贴给你的编程助手,让它自动完成这一步。
我需要安装 Node.js 吗?它能配合我的编程代理使用吗?需要 Node.js 20.19.0 或更高版本;它可以通过斜杠命令与 30 多种 AI 编程工具配合使用,包括 Cursor、GitHub Copilot、Amazon Q 和 Codex。
它在任何 AI 模型上的效果都一样好吗?它在高推理能力的模型上效果最好,作者特别推荐 Codex 5.5 和 Opus 4.7;并且在开始实现之前,你应该保持上下文窗口干净。
这只适合单人开发者,还是也能扩展到团队?它可以单人用于单个仓库,也可以通过 'Stores'(目前处于测试阶段)扩展到团队,让多个仓库共享同一个规范和进行中变更的单一事实来源。
OpenSpec 会把我的代码或数据发送到外部吗?它只收集命令名称和版本号的匿名遥测数据,不包括参数、路径、内容或个人身份信息(PII);在 CI 环境中会自动关闭,你也可以选择退出。
它与 GitHub 的 Spec Kit 或 AWS Kiro 有什么不同?据描述,Spec Kit 很全面,但比较笨重,有严格的阶段关卡,并且需要配置 Python 环境;Kiro 则把你锁定在 AWS 的 IDE 中,只能使用 Claude 模型。OpenSpec 更轻量,允许你自由迭代,并且可以配合你已经在用的任何编程工具。
一个典型的工作流程是什么样的?你可以运行 /opsx:explore 来梳理一个想法,或运行 /opsx:propose 直接生成方案;AI 会编写规范,你在编写任何代码之前先审阅。每个变更都有自己的文件夹,包含提案、规范、设计和任务。
README 里提到的 Dashboard 是什么?它是 OpenSpec 自身规范和进行中变更的实时视图。由于 OpenSpec 本身就是用 OpenSpec 构建的,它也是该工具在较大规模下使用的真实案例。
除了 npm,我能用其他包管理器吗?可以,它也支持 pnpm、yarn、bun 和 nix。
Creator
Fission-AI
Size
10.9 MB
Stars
72.3K
Age
1y
Commits · 90 Days