Skip to content

Latest commit

 

History

History
160 lines (105 loc) · 9.62 KB

File metadata and controls

160 lines (105 loc) · 9.62 KB

命令如何运作

唯一需要知道的事:OpenSpec 有两类命令,它们运行在两个不同的地方。

  • openspec ... 命令运行在你的终端中。(例:openspec-cn init。)
  • /opsx:... 命令运行在你的 AI 助手的聊天框中。(例:/opsx:propose。)

如果你曾在终端里输入 /opsx:propose 却毫无反应,原因就是本页所讲。你是在和 OpenSpec 的终端部分对话,而非聊天部分。斜杠命令不是终端命令。它们是你在与 AI 编程助手对话的同一个聊天框里给出的指令——通常你会在那里输入"add a login form"。

这唯一的区别是新用户最常见的绊脚石,所以我们把它讲得清清楚楚。

两半

OpenSpec 是一个戴了两顶帽子的项目。

CLI(终端一半)。 一个名叫 openspec 的程序,你安装并从 shell 运行它。它设置你的项目、列出并验证变更、显示仪表盘,并归档已完成的工作。你把这些输入到 iTerm、VS Code 终端、PowerShell——任何你会运行 gitnpm 的地方。

openspec-cn init        # set up OpenSpec in this project
openspec-cn list        # see active changes
openspec-cn view        # open the interactive dashboard

斜杠命令(聊天一半)。/opsx:propose/opsx:apply 这样的短命令,你输入到 AI 助手中。它们告诉 AI 遵循 OpenSpec 工作流:起草 proposal、编写 specs、基于任务列表构建、完成时归档。你把这些输入到 Claude Code、Cursor、Windsurf、Copilot,或你使用的任何助手中。

/opsx:propose add-dark-mode    (typed in your AI chat)
/opsx:apply                    (typed in your AI chat)
/opsx:archive                  (typed in your AI chat)

用一张图来表达这个思维模型:

        YOUR TERMINAL                         YOUR AI ASSISTANT'S CHAT
   ┌──────────────────────┐               ┌──────────────────────────────┐
   │  $ openspec-cn init     │   installs    │  /opsx:propose add-dark-mode  │
   │  $ openspec-cn list     │  ──────────►  │  /opsx:apply                  │
   │  $ openspec-cn view     │   commands    │  /opsx:archive                │
   └──────────────────────┘    & skills   └──────────────────────────────┘
        run openspec-cn here                       run /opsx:* here

注意那个箭头。在终端运行 openspec-cn init,正是把斜杠命令安装进你的 AI 工具。终端一半设置了聊天一半。此后,日常驱动主要发生在聊天中。

"我如何启动交互模式?"

没有单独的"交互模式"需要启动。 这个问题经常出现,所以它值得一个直白的回答。

你不会进入一个特殊的 OpenSpec 模式。你只需像往常一样打开你的 AI 编程助手,并在聊天中输入一条斜杠命令。斜杠命令就是你"进入" OpenSpec 的方式。你的助手识别它,加载对应的 OpenSpec skill,然后开始遵循工作流。

所以真正的操作指引是:

  1. 在你的项目中打开 AI 编程助手(Claude Code、Cursor、Windsurf,等等)。
  2. 在它的聊天中输入 /opsx:propose,与输入任何其他请求的同一处。
  3. 观察自动补全:如果 OpenSpec 已安装,你会在输入斜杠时看到 /opsx:propose/opsx:apply 等冒出来。

就这些。没有要切换的模式,没有要启动的守护进程,没有单独的窗口。

终端里有一件事确实是交互式的:openspec-cn view。它打开一个用于浏览你的 specs 与变更的仪表盘。但那是个查看器,而非你用来提议和构建的东西。构建是通过聊天中的斜杠命令进行的。

为何存在这种划分

值得理解,因为它解释了 OpenSpec 为何能与 25+ 种不同的 AI 工具协作。

CLI 是引擎。它了解规则:一个变更文件夹长什么样、哪些制品依赖哪些、如何把增量规范合并进你的事实来源。它处处相同。

斜杠命令是方向盘,而每个 AI 工具有一个略有不同的方向盘。Claude Code 称之为 commands。Cursor 和 Windsurf 有它们自己的格式。有些工具称之为 skills。当你运行 openspec-cn init 时,OpenSpec 为你所选的每个工具生成正确种类的文件,因此同一个 /opsx:propose 意图无论你偏好哪个助手都能运作。

这种设计的长处:你学一次工作流,就能带到各个工具间。代价:一条命令的确切语法在不同工具间可能略有差异,这正是下一节内容。

各工具的斜杠命令语法

意图处处相同。标点不同。使用匹配你助手的形式。

工具 如何输入
Claude Code /opsx:propose, /opsx:apply
Cursor /opsx-propose, /opsx-apply
Windsurf /opsx-propose, /opsx-apply
GitHub Copilot (IDE) /opsx-propose, /opsx-apply
Oh My Pi /opsx-propose, /opsx-apply
Kimi CLI skill 形式,如 /skill:openspec-propose
Trae /opsx-propose, /opsx-apply

大多数工具使用冒号形式(/opsx:propose)或短横线形式(/opsx-propose)。少数工具把 OpenSpec 作为具名 skills 而非斜杠命令呈现;对于这些,你按名字调用 skill。包含确切文件写入位置的逐工具完整列表,见支持的工具

拿不准时,在你的 AI 聊天中输入一个斜杠,看自动补全。你的工具会显示它期望的形式。

命令从何而来:skills 与 commands

当你运行 openspec-cn init(或 openspec-cn update)时,OpenSpec 把小文件写入你的项目,以便你的 AI 工具能找到该工作流。取决于你的工具与设置,这些文件是 skillscommands,或两者皆有。

  • Skills 位于 .claude/skills/openspec-*/SKILL.md 这类位置。它们是新兴的跨工具标准:一个你的助手自动检测的指令文件夹。
  • Commands 位于 .claude/commands/opsx/<id>.md 这类位置。它们是较老的、每工具专属的斜杠命令文件。

你无需关心你的工具用哪一种。你只需输入斜杠命令,它就能工作。但当出问题时,知道这些文件存在是有帮助的:如果你的命令消失了,通常意味着这些文件缺失或过期,而 openspec-cn update 会重新生成它们。

逐工具的精确路径见支持的工具,skills 如何取代旧的纯命令方式见迁移指南

确认它已安装

快速检查,按从快到慢:

  1. 在你的 AI 聊天中输入一个斜杠。 开始输入 /opsx 并观察是否有自动补全建议出现。如果它们出现了,你就已就绪。
  2. 查找文件。 对于 Claude Code,检查 .claude/skills/ 是否包含 openspec-* 文件夹。其他工具使用它们自己的目录(支持的工具列出了它们)。
  3. 重新运行设置。 从你的项目根目录运行 openspec-cn update。这会为你配置过的任何工具重新生成 skill 和 command 文件。
  4. 重启你的助手。 许多工具在启动时扫描 skills 和 commands,所以一个新窗口可能就是缺失的那一步。

我到底有哪些命令

默认情况下,OpenSpec 安装 core 这组斜杠命令:

  • /opsx:explore:在下定决心前与 AI 一起想清楚一个想法(拿不准时极好的第一步)
  • /opsx:propose:创建一个变更并一步起草它的所有规划制品
  • /opsx:apply:通过完成其任务列表来构建变更
  • /opsx:sync:把变更的 spec 更新合并进你的主 specs(通常是自动的)
  • /opsx:archive:完成一个变更并把它归档

一个不错的默认节奏:拿不准要做什么时用 explore,然后 proposeapplyarchive先探索指南解释了为何这第一步值得。

还有一套扩展命令,给想要更细控制的人(/opsx:new/opsx:continue/opsx:ff/opsx:verify/opsx:bulk-archive/opsx:onboard)。你用 openspec-cn config profile 开启它,再用 openspec-cn update 应用。

这一切对你而言是全新的?/opsx:onboard(在扩展集中)会在你自己的代码库上带你走完一个完整变更,逐步旁白。它是最友好的可能入门。

每个命令的详细功能,见命令。何时该用哪个,见工作流

一次干净的首跑

综合起来,这里是从头到尾的整个序列,每步标注了它发生的位置。

TERMINAL   $ npm install -g @fission-ai/openspec@latest
TERMINAL   $ cd your-project
TERMINAL   $ openspec-cn init
              (installs slash commands into your AI tool)

AI CHAT      /opsx:explore
              (optional: think the idea through with the AI first)

AI CHAT      /opsx:propose add-dark-mode
              (AI drafts proposal, specs, design, tasks)

AI CHAT      /opsx:apply
              (AI builds it, checking off tasks)

AI CHAT      /opsx:archive
              (change is merged into your specs and filed away)

两步终端操作完成设置。然后你就在聊天里了。这就是节奏。

相关