关于 openspec-initial
使用 `openspec init` 在项目中初始化 OpenSpec,创建所需目录并配置所选 AI 工具的集成。
主要功能
- 01创建 OpenSpec 项目目录
- 02配置受支持的 AI 工具集成
- 03交互式或通过参数选择工具
- 04可选创建项目配置
适用场景
- 01首次在项目中设置 OpenSpec
- 02添加或更改 AI 工具集成
- 03在指定目录初始化 OpenSpec
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ full-stack-skills/ openspec-skills --skill openspec-initial安装后在 Claude Code 中输入/openspec-initial确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlexamples/all-tools.mdclaude-cursor.md详细介绍
OpenSpec 初始技能
运行 openspec init 可在项目中初始化 OpenSpec:创建 openspec/ 目录(规格、变更、配置),并配置 AI 工具集成(技能和斜杠命令)。此技能假设已安装 OpenSpec CLI;如果尚未安装,请先引导用户使用 openspec-install。
适用场景
- 首次在项目中启用 OpenSpec(“初始化 OpenSpec”“在此处设置 OpenSpec”)。
- 向现有项目添加 AI 工具集成(Claude、Cursor、Windsurf 等)。
- 更改工具选择后重新初始化。
前提条件
- 已安装 OpenSpec CLI(参见 openspec-install)。如果
openspec不在 PATH 中,请先引导用户运行 openspec-install,再继续操作。
工作流
-
验证 CLI
- 如果用户报告“找不到 openspec 命令”,请先引导他们使用 openspec-install。
-
选择参数
- path(可选):目标目录;默认为当前目录。
- --tools(可选):以非交互方式配置 AI 工具。可选值:
all、none或逗号分隔的列表(例如claude,cursor)。 - --force:自动清理旧版文件,无需提示。
-
运行命令
- 交互式:
openspec init - 使用指定工具的非交互方式:
openspec init --tools claude,cursor - 所有工具:
openspec init --tools all - 指定目录:
openspec init ./my-project
- 交互式:
-
可选:创建项目配置
- 在初始化期间,系统可能会提示用户创建
openspec/config.yaml,其中包含项目上下文、架构默认值和各工件规则。此步骤为可选,但建议执行。详情请参见 openspec-config。
- 在初始化期间,系统可能会提示用户创建
-
确认输出
- 成功后:
openspec/目录下包含specs/、changes/,以及可选的config.yaml。根据所选工具创建对应的工具目录(.claude/skills/、.cursor/rules/等)。
- 成功后:
支持的工具
amazon-q、antigravity、auggie、claude、cline、codebuddy、codex、continue、costrict、crush、cursor、factory、gemini、github-copilot、iflow、kilocode、opencode、qoder、qwen、roocode、trae、windsurf
输出
- openspec/:
specs/— 规格(事实来源)changes/— 提议的变更config.yaml— 项目配置(可选)
- 工具配置:根据所选工具创建
.claude/skills/、.cursor/rules/、.windsurf/skills/等。
后续步骤
- 升级 CLI 后,使用 openspec-update 重新生成工具配置。
- 使用 openspec-onboard,按照引导了解完整工作流。
- 或开始工作:使用 openspec-explore 梳理想法,使用 openspec-new 开始一项变更。
不同环境
| 场景 | 命令 |
|---|---|
| 交互式 | openspec init |
| Claude + Cursor | openspec init --tools claude,cursor |
| 所有工具 | openspec init --tools all |
| 指定目录 | openspec init ./my-project |
| CI / 非交互式 | openspec init --tools claude --force |
| 跳过工具配置 | openspec init --tools none |
故障排除
- “openspec: command not found”:请先使用 openspec-install。
- 检测到旧版文件:使用
--force自动清理,或按照交互式提示操作。 - 工具不在列表中:查看支持的工具列表,确认正确的 ID。
参考资料
评论
支持 Markdown