Note
本项目为中文汉化分支:openspec-cn(npm:@studyzy/openspec-cn)。
原版项目:OpenSpec(仓库:https://github.com/Fission-AI/OpenSpec,npm:@fission-ai/openspec)。
→ 灵活,而非僵化
→ 迭代,而非瀑布式
→ 简单,而非复杂
→ 面向存量项目(brownfield),而不只是新项目(greenfield)
→ 从个人项目到企业规模都可扩展
关注 X 上的 @0xTab 获取更新 · 加入 OpenSpec Discord 获取帮助与答疑。
团队正在使用 OpenSpec?可 发送邮件 获取我们 Slack 频道的访问权限。
你:/opsx:new add-dark-mode
AI:创建 openspec/changes/add-dark-mode/
准备创建:proposal
你:/opsx:ff # "fast-forward" - 生成全部规划文档
AI:✓ proposal.md — 为什么要做、会改什么
✓ specs/ — 需求与场景
✓ design.md — 技术方案
✓ tasks.md — 实现清单
准备进入实现!
你:/opsx:apply
AI:开始实现任务...
✓ 1.1 添加主题上下文 Provider
✓ 1.2 创建切换组件
✓ 2.1 添加 CSS 变量
✓ 2.2 接入 localStorage
所有任务已完成!
你:/opsx:archive
AI:已归档至 openspec/changes/archive/2025-01-23-add-dark-mode/
Specs 已更新。可以开始下一个功能了。
需要 Node.js 20.19.0 或更高版本。
全局安装 openspec-cn:
npm install -g @studyzy/openspec-cn@latest然后进入你的项目目录并初始化:
cd your-project
openspec-cn init
现在告诉你的 AI:/opsx:new <你想要实现的功能>
→ 快速入门:开始使用
→ 工作流:组合与模式
→ 命令:斜杠命令与技能
→ CLI:终端参考手册
→ 支持的工具:工具集成与安装路径
→ 概念:整体如何运转
→ 多语言:多语言支持
→ 自定义:打造你的版本
AI 编程助手很强大,但当需求只存在于聊天记录里时,结果往往难以预测。OpenSpec 增加了一层轻量的规范(spec)机制,让你在写任何代码前先对齐要做什么。
- 先对齐,再开工 —— 人类与 AI 在写代码前先在规范上达成一致
- 保持有序 —— 每个变更都有自己的目录:proposal、specs、design、tasks
- 流式协作 —— 任意制品都可以随时更新,不设僵硬的阶段门槛
- 用你现有的工具 —— 通过斜杠命令支持 20+ AI 助手
对比 Spec Kit(GitHub)—— 很全面但偏厚重:阶段门槛严格、Markdown 很多、需要 Python 环境。OpenSpec 更轻量,也更适合自由迭代。
对比 Kiro(AWS)—— 功能强大,但会被锁定在他们的 IDE 中,并且模型选择受限(主要是 Claude)。OpenSpec 可与您已有的工具协作。
对比“什么都不用” —— 只靠聊天做 AI 编程容易产生模糊需求和不可预测的实现。OpenSpec 在不增加太多仪式感的前提下,带来更可预期的结果。
升级包版本
npm install -g @studyzy/openspec-cn@latest刷新代理指令(agent instructions)
在每个项目里运行一次,用于重新生成 AI 指引,并确保最新斜杠命令可用:
openspec-cn update模型选择:OpenSpec 更适合高推理模型。我们推荐在规划与实现阶段都使用 Opus 4.5 和 GPT 5.2。
上下文卫生:OpenSpec 受益于更干净的上下文窗口。在开始实现前清理上下文,并在整个会话中保持良好的上下文卫生。
小修小补 —— Bug 修复、错别字修正与小型改进可以直接提交 PR。
较大改动 —— 对于新功能、重大重构或架构调整,请先提交一个 OpenSpec 变更提案,以便在实现前对齐意图与目标。
撰写提案时,请牢记 OpenSpec 的理念:我们服务于各种不同的编码代理、模型与使用场景。改动应对所有人都工作良好。
欢迎 AI 生成代码 —— 只要经过测试与验证即可。包含 AI 生成代码的 PR 应注明使用的编码代理与模型(例如:"Generated with Claude Code using claude-opus-4-5-20251101")。
- 安装依赖:
pnpm install - 构建:
pnpm run build - 测试:
pnpm test - 本地开发 CLI:
pnpm run dev或pnpm run dev:cli - 约定式提交(单行):
type(scope): subject
遥测(Telemetry)
OpenSpec 会收集匿名使用统计。
我们只收集命令名与版本号,用于理解使用模式;不会收集参数、路径、内容或任何个人信息。CI 中会自动禁用。
退出(Opt-out): export OPENSPEC_TELEMETRY=0 或 export DO_NOT_TRACK=1
维护者与顾问
核心维护者与顾问列表见 MAINTAINERS.md。
MIT
