快速开始
这份 Quick Start 以 “先完成宿主准备与 Stage-0,再进入主工作流” 为准。
本页默认用 Claude Code 语法示例;如果你使用 Codex,请将
/spec:*对应替换为$spec-*。
前置条件
- 已按 安装指南 安装
spec-first - 当前目录是 Git 仓库
- 已安装 Claude Code 或 Codex
第一步:检查环境并初始化项目
bash
# 进入你的项目目录
cd my-project
# 检查环境
spec-first doctor
# 初始化到 Claude Code
spec-first init --claude
# 如果你用 Codex,则改为:
# spec-first init --codex初始化后请 重启宿主 CLI,让新的运行时入口生效。
第二步:完成宿主准备
在 Claude Code 中运行:
bash
/spec:mcp-setup如果你使用 Codex,则运行:
bash
$spec-mcp-setup这一步的意义是确认宿主侧的 MCP 与运行环境可用。当前产品 README 明确把它放在 graph-bootstrap 之前。
第三步:构建 Stage-0 上下文
bash
/spec:graph-bootstrap或在 Codex 中:
bash
$spec-graph-bootstrap这一步会把代码库编译成后续 workflow 要消费的结构化上下文,核心产物包括:
- Phase 0–4 facts
injection-index.yamlminimal-context/*.json
如果你跳过这一步,Plan / Work / Review 的事实基线会明显变弱。
第四步:进入主工作流
根据你的起点选择入口:
情况 A:还不知道要做什么
bash
/spec:ideate情况 B:方向已有,但需求边界还不清楚
bash
/spec:brainstorm "给项目添加一个健康检查接口"情况 C:需求已经清楚,直接做计划
bash
/spec:plan docs/brainstorms/2026-04-20-health-check-requirements.md一条最小可执行链路
如果你想体验最典型的一次交付闭环,可以按下面顺序执行:
bash
/spec:brainstorm "给项目添加一个健康检查接口"
/spec:plan docs/brainstorms/2026-04-20-health-check-requirements.md
/spec:work docs/plans/2026-04-20-001-feat-health-check-plan.md
/spec:review
/spec:compound在 Codex 中,对应写法是:
bash
$spec-brainstorm "给项目添加一个健康检查接口"
$spec-plan docs/brainstorms/2026-04-20-health-check-requirements.md
$spec-work docs/plans/2026-04-20-001-feat-health-check-plan.md
$spec-review
$spec-compound每一步会产出什么
| 阶段 | 典型产物 |
|---|---|
spec-mcp-setup | 宿主 readiness marker |
spec-graph-bootstrap | facts + injection-index.yaml + minimal-context/*.json |
spec-brainstorm | docs/brainstorms/*.md |
spec-plan | docs/plans/*.md |
spec-work | 代码 + 测试 |
spec-review | 结构化评审报告 |
spec-compound | docs/solutions/**/*.md |
常见起步误区
- 只运行
init,但没有重启宿主 - 直接从
Brainstorm或Plan开始,跳过spec-mcp-setup - 直接进入
Work,没有先做spec-graph-bootstrap - 把 Codex 错写成
/spec:*