跳到主要内容

快速开始指南

本指南将帮助你在 5 分钟内开始使用 OpenSpec。

安装 OpenSpec​

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

初始化项目​

cd your-project
openspec init

这将：

  • 在项目中创建 openspec/ 文件夹
  • 生成示例规范
  • 设置默认配置

创建你的第一个变更​

在你的 AI 编码助手的聊天界面中输入：

/opsx:propose add-dark-mode

AI 将创建：

  • openspec/changes/add-dark-mode/proposal.md - 提案
  • openspec/changes/add-dark-mode/specs/ - 规范
  • openspec/changes/add-dark-mode/design.md - 设计
  • openspec/changes/add-dark-mode/tasks.md - 任务列表

实施变更​

You: /opsx:apply
AI:  Working through tasks...
     ✓ 1.1 Created ThemeContext with light/dark state
     ✓ 1.2 Added CSS custom properties to globals.css
     ✓ 1.3 Implemented localStorage persistence
     ✓ 2.1 Created ThemeToggle component
     ...
     All tasks complete!

归档变更​

You: /opsx:archive
AI:  Archiving add-dark-mode...
     ✓ Merged specs into openspec/specs/ui/spec.md
     ✓ Moved to openspec/changes/archive/2025-01-24-add-dark-mode/
     Done! Ready for the next feature.

工作流​

默认快速路径（核心配置文件）：

/opsx:propose ──► /opsx:apply ──► /opsx:archive

扩展路径（自定义工作流选择）：

/opsx:new ──► /opsx:ff or /opsx:continue ──► /opsx:apply ──► /opsx:verify ──► /opsx:archive

下一步​

系统要求​

  • Node.js 20.19.0 或更高版本
  • 支持 slash 命令的 AI 编码助手

常见问题​

Q: OpenSpec 支持哪些 AI 助手？
A: OpenSpec 支持 20+ AI 助手，包括 Claude Code、Cursor、Windsurf、GitHub Copilot 等。

Q: OpenSpec 可以与现有代码库一起使用吗？
A: 是的！OpenSpec 的增量规范方法使其非常适合现有（存量）代码库。

Q: 我可以在团队中使用 OpenSpec 吗？
A: 是的！OpenSpec 专为团队协作而设计。联系团队 获取 Slack 频道访问权限。