Fission-AI/OpenSpec

最受欢迎的规范框架。

我们的理念： ``` → fluid not rigid → iterative not waterfall → easy not complex → built for brownfield not just greenfield → scalable from personal projects to enterprises ```

关注 X 上的 @0xTab 获取更新 · 加入 OpenSpec Discord 寻求帮助与提问。

## 实际效果 ``` 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. ```

OpenSpec Dashboard

## 快速开始 **需要 Node.js 20.19.0 或更高版本。** 全局安装 OpenSpec： ``` npm install -g @fission-ai/openspec@latest ``` 然后导航到你的项目目录并初始化： ``` cd your-project openspec init ``` 现在与你的 AI 对话： - **还不确定要构建什么？** 从 `/opsx:explore` 开始，它是一个零成本的思考伙伴，能在编写任何代码之前阅读你的代码、权衡选项并制定计划。（[Explore 指南](docs/explore.md)） - **已经知道你想要什么了？** 直接使用 `/opsx:propose <你要构建的内容>`。 两者都在默认 profile 中。如果你想要扩展的工作流（`/opsx:new`、`/opsx:continue`、`/opsx:ff`、`/opsx:verify`、`/opsx:bulk-archive`、`/opsx:onboard`），请使用 `openspec config profile` 进行选择，并使用 `openspec update` 应用。 ## 文档 **从这里开始：** **[文档首页](docs/README.md)** 涵盖了所有内容。刚接触 OpenSpec？请阅读[入门指南](docs/getting-started.md)，然后阅读[命令是如何工作的](docs/how-commands-work.md)（你实际输入 `/opsx:propose` 的地方）。 → **[入门指南](docs/getting-started.md)**：第一步
→ **[先进行探索](docs/explore.md)**：在提交之前使用 `/opsx:explore` 深入思考
→ **[命令是如何工作的](docs/how-commands-work.md)**：slash 命令在哪里运行以及 CLI
→ **[核心概念一览](docs/overview.md)**：整个心智模型，一页纸
→ **[示例与方案](docs/examples.md)**：真实的变更，从头到尾
→ **[工作流](docs/workflows.md)**：组合与模式
→ **[现有项目](docs/existing-projects.md)**：在既有代码库上采用 OpenSpec
→ **[编辑变更](docs/editing-changes.md)**：更新 artifacts、回退、协调手动编辑
→ **[命令](docs/commands.md)**：slash 命令与技能
→ **[CLI](docs/cli.md)**：终端参考
→ **[Stores](docs/stores-beta/user-guide.md)**：在独立的 repo 中规划，与你的团队共享 (beta)
→ **[支持的工​​具](docs/supported-tools.md)**：工具集成与安装路径
→ **[概念](docs/concepts.md)**：它们是如何组合在一起的
→ **[多语言](docs/multi-language.md)**：多语言支持
→ **[自定义](docs/customization.md)**：打造你的专属配置
→ **[FAQ](docs/faq.md)** · **[故障排除](docs/troubleshooting.md)** · **[术语表](docs/glossary.md)**：快速帮助 ## 社区 schema 通过独立 repo 分发的第三方 schema 包——它们提供将 OpenSpec 与其他工具集成的、具有特定主张的工作流，类似于 [github/spec-kit 的社区扩展目录](https://github.com/github/spec-kit/tree/main/extensions)处理工具集成的方式。 → 在自定义文档中**[浏览目录](docs/customization.md#community-schemas)**。 ## 为什么选择 OpenSpec？ 当需求仅存在于聊天记录中时，AI 编程助手虽然强大，但表现往往不可预测。OpenSpec 添加了一个轻量级的 spec 层，让你在任何代码编写之前就明确要构建的内容。 - **构建前达成共识** — 人类和 AI 在编写代码之前先对 spec 达成一致 - **保持条理** — 每个变更都有专属文件夹，包含提案、spec、设计和任务 - **流畅工作** — 随时更新任何 artifact，没有死板的阶段限制 - **使用你的工具** — 通过 slash 命令支持 20 多种 AI 助手 ### 对比 **对比 [Spec Kit](https://github.com/github/spec-kit)** (GitHub) — 功能全面但较为繁重。具有严格的阶段限制、大量的 Markdown 文件以及 Python 设置。OpenSpec 更轻量，并允许你自由迭代。 **对比 [Kiro](https://kiro.dev)** (AWS) — 功能强大，但你被锁定在他们的 IDE 中，并且仅限于 Claude 模型。OpenSpec 可以与你已经在使用的工具一起工作。 **对比不使用任何规范** — 没有规范的 AI 编程意味着模糊的 prompt 和不可预测的结果。OpenSpec 在不增加繁文缛节的情况下带来了可预测性。 ## 更新 OpenSpec **升级包** ``` npm install -g @fission-ai/openspec@latest ``` **刷新 agent 指令** 在每个项目中运行此命令以重新生成 AI 指导，并确保最新的 slash 命令处于激活状态： ``` openspec update ``` ## 使用说明 **模型选择**：OpenSpec 与高推理能力模型配合使用效果最佳。我们推荐在规划和实现阶段均使用 Codex 5.5 和 Opus 4.7。 **上下文整洁**：OpenSpec 受益于干净的上下文窗口。在开始实现之前清除你的上下文，并在整个会话过程中保持良好的上下文整洁度。 ### 开发 - 安装依赖：`pnpm install` - 构建：`pnpm run build` - 测试：`pnpm test` - 本地开发 CLI：`pnpm run dev` 或 `pnpm run dev:cli` - 约定式提交 (单行)：`type(scope): subject` ## 其他

遥测

OpenSpec 会收集匿名的使用统计数据。 我们仅收集命令名称和版本，以了解使用模式。不包含任何参数、路径、内容或 PII（个人身份信息）。在 CI 中会自动禁用。 **退出：** `export OPENSPEC_TELEMETRY=0` 或 `export DO_NOT_TRACK=1`

维护者与顾问

请参阅 [MAINTAINERS.md](MAINTAINERS.md) 获取帮助指导该项目的核心维护者和顾问名单。

## License MIT

标签：AI编程辅助, GNU通用公共许可证, MITM代理, Node.js, SOC Prime, 开发工具, 暗色界面, 自动化攻击, 规范驱动开发