Skip to content

cokepoppy/simple-spec

Repository files navigation

simple-spec

把 Simple-Spec 的斜杠命令安装到 Codex CLI / Claude Code,用于在仓库里按 spec → plan → exec → adjust/apply 的方式落盘记录与推进变更。

3 分钟上手(推荐)

前置:已安装 Node.js(建议 LTS)与 npm。

  1. 本地安装 CLI(从本仓库安装):
npm install -g ./packages/simplespec
  1. 安装斜杠命令(Codex + Claude 一次装完):
simplespec install all
  1. 重启 Codex CLI / Claude Code,然后开始用:
  • Codex CLI:
    • 标准:/prompts:simple:spec 写一个...
    • 简化:/prompts:simple:specsimple 写一个...
  • Claude Code:
    • 标准:/simple:spec 写一个...
    • 简化:/simple:specsimple 写一个...

工作流(推荐:最新简化流程)

只需要两步:specsimple → exec

flowchart TD
  A[用户输入原始需求] --> B["/simple:specsimple 或 /prompts:simple:specsimple"]
  B --> C["创建 simple-spec/change-id/"]
  C --> D["写入 spec.md<br/>(保留原始需求)"]
  C --> E["生成 plan.md<br/>(Codex 自动生成实施计划)"]
  E --> F["用户查看 plan.md 确认"]
  F --> G["/simple:exec 或 /prompts:simple:exec<br/>可选附带追加说明"]
  G --> H{是否有追加说明?}
  H -- 是 --> I["将追加说明 append 到 spec.md"]
  H -- 否 --> J["直接按 plan/spec 执行"]
  I --> J
  J --> K["实施变更 + 运行验证"]
  K --> L["写入 exec.md<br/>(摘要/变更明细/验证/备注)"]
  L --> M["如需继续:/simple:adjust → /simple:apply"]
Loading
  1. 生成需求与计划(一次性落盘):
  • Codex CLI:/prompts:simple:specsimple <原始需求>
  • Claude Code:/simple:specsimple <原始需求>

会创建:

  • simple-spec/<change-id>/spec.md(原始需求为主)
  • simple-spec/<change-id>/plan.md(由模型自动生成的实施计划)
  1. 你打开 plan.md 看一眼,确认没问题后执行:
  • Codex CLI:/prompts:simple:exec --id <change-id>
  • Claude Code:/simple:exec --id <change-id>

exec 追加修改/澄清(最省事)

如果你在执行 exec 时发现需要改动/补充需求,可以直接把补充内容写在命令后面:

  • Codex CLI:/prompts:simple:exec --id <change-id> 把A改成B,并补充C的边界条件
  • Claude Code:/simple:exec --id <change-id> 把A改成B,并补充C的边界条件

规则:exec 会先把这段“追加说明”append 到 simple-spec/<change-id>/spec.md 的末尾,然后再据此执行,并产出 simple-spec/<change-id>/exec.md


其他工作流(仍然支持)

  • 快速:spec → exec
  • 标准:spec → (clarify) → plan → exec
  • 纠偏:adjust → apply(直到验收通过)

<change-id> 可选:不传 --id 时,默认操作 simple-spec/ 下最新的目录。

验证安装

simplespec --help
simplespec --version

命令安装位置(需要时再看)

  • Codex prompts:${CODEX_HOME:-$HOME/.codex}/prompts
  • Claude commands:$HOME/.claude/commands

进阶(CI / 打包安装)

cd packages/simplespec
npm pack --pack-destination /tmp
npm install -g /tmp/coke-coke-ai-simplespec-*.tgz
simplespec install all

相关文档

  • docs/best-practices.md
  • docs/simple-spec-proposal.md
  • docs/simple-spec-implementation-log.md

About

简化版本的open spec 规约编程框架

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published