一、介绍和安装
1、简介
OpenSpec 是一个规范驱动的开发框架,用于 AI 编程助手。它帮助团队创建和管理代码规范、变更提案和项目结构。
2、安装要求
- **Node.js**: 版本 20.19.0 或更高 - **包管理器**: npm, pnpm, 或 yarn
3、安装方法
以下建议在powershell中进行
(1)防止有SSL证书问题
$env:NODE_TLS_REJECT_UNAUTHORIZED="0"(2)安装
npm install -g @fission-ai/openspec@latest如我的:
安装完成后,验证是否成功:如果显示版本号,说明安装成功。
openspec --version二、初始化项目
仍建议在powershell中进行。先cd到你项目的根目录下,然后执行
openspec init这会创建 `.openspec` 目录结构和 `AGENTS.md` 文件。
三、使用
基本工作流程
探索 (Explore) - 在开始前思考问题
新建变更 (New) - 创建变更容器
提案 (Proposal) - 记录为什么要做这个变更
规范 (Specs) - 定义要构建什么(详细需求)
设计 (Design) - 决定如何构建
任务 (Tasks) - 分解为实施步骤
应用 (Apply) - 实施任务
归档 (Archive) - 完成后归档变更
可用命令
| 命令 | 说明 |
|---|---|
| /opsx:explore | 在开始前探索和思考问题 |
| /opsx:new | 创建新变更,逐步创建所有工件 |
| /opsx:ff | 快速创建所有工件(不逐步) |
| /opsx:continue | 继续处理现有变更 |
| /opsx:apply | 实施变更中的任务 |
| /opsx:verify | 验证实施是否匹配工件 |
| /opsx:archive | 归档已完成的变更 |