首页 / 详情
Site icon

Spec Kit

基本信息

Spec Kit 网站截图预览

工具详情

GitHub Spec-Kit 使用指南

一、平台介绍

  1. 核心理念 *将开发模式从“先写代码再补文档”翻转为“规范即执行”。*通过逐步生成可评审的文档(宪法、需求规范、技术方案、任务清单),为 AI Agent 提供稳定的契约。
  2. 项目性质 开源工具包,包含 specify CLI 命令行工具 + Agent Prompt 模板 + 脚本库。
  3. 开源协议 MIT License(完全开源)。

二、主要功能

  1. 项目脚手架(Specify CLI) 一键生成规范驱动开发所需的目录结构、提示词及配置文件。
  2. 阶段化斜杠指令(Slash Commands)
  • /speckit.constitution:定义项目的全局不可违背准则,包括代码规范、架构约束、测试要求等。
  • /speckit.specify:专注于“业务要做什么(What/Why)”,生成高层需求规范 spec.md,不掺杂技术细节。
  • /speckit.clarify:主动提问以检查需求中的二义性、模糊点及边缘场景并补充完善。
  • /speckit.plan:专注于“技术怎么做(How)”,制定技术选型、数据模型与架构方案 plan.md
  • /speckit.tasks:将方案拆解为带依赖关系、可并行执行的确定性任务清单 tasks.md
  • /speckit.analyze:交叉检查 Consistency,确保规范、方案、任务之间的一致性。
  • /speckit.implement:驱动 Agent 按任务列表分步、小步快跑地编写代码。
  1. 广泛的 Agent 生态集成 支持 GitHub Copilot、Claude Code、Cursor、Gemini CLI、Windsurf 等 30+ 款主流 AI 编码 Agent。

三、适用人群

  1. AI 辅助开发者 / 独立开发者:希望用 AI 写大中型项目,但不想让 AI 乱改代码或迷失方向。
  2. 软件架构师 / 技术 Leader:需要制定代码约束与架构规范(Constitution),控制 AI 输出质量。
  3. 研发团队 / Product Manager:希望在写代码前快速评审需求规格 spec.md,确保产品与工程对齐。

四、免费与付费情况

  1. Spec-Kit 本身费用:完全免费且开源。没有官方的付费商业版或订阅模式。
  2. 第三方成本说明:使用 Spec-Kit 需要配合 AI Coding Agent 或 LLM API(如 GitHub Copilot 订阅、Claude API、OpenAI API 等),这部分按对应厂商的定价付费。
  3. 相关网址链接:
  • Spec-Kit 官方 GitHub 仓库:github.com/github/spec-kit
  • GitHub Copilot 定价页面(若搭配 Copilot 使用):github.com/pricing

五、如何使用(标准工作流)

  1. 安装 CLI
  2. 需要先安装 Python 的极速包管理器 uv。随后在项目根目录运行以下命令以集成 Copilot 或 Cursor:
  3. bash
# 通过 uv 安装 specify-cli
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git

# 初始化项目并指定集成方式(此处示例为 copilot)
specify init my-project --integration copilot

cd my-project
  1. 执行标准七步法
  2. 在 Agent Chat 中按顺序使用斜杠指令:
  3. /speckit.constitution:生成 constitution.md,录入项目不可逾越的规则。
  4. /speckit.specify <需求描述>:用自然语言描述需求,生成 spec.md(What/Why)。
  5. /speckit.clarify:让 AI 审查 spec.md,回答其提出的补全问题并完善细节。
  6. /speckit.plan:给出技术偏好(如“使用 Go + PostgreSQL"),生成 plan.md(How)。
  7. /speckit.tasks:生成分步骤的任务列表 tasks.md
  8. /speckit.analyze:运行一致性检查,确保任务和方案无冲突。
  9. /speckit.implement:让 AI 逐条完成 tasks.md 中的编码任务。

六、注意事项

  1. 严禁越级编码 在没有审核通过 spec.mdplan.md 之前,不要直接跳到 /speckit.implement 进行生成代码操作。
  2. 任务颗粒度控制 如果 tasks.md 中某个任务过于庞大,应当让 Agent 继续拆细,否则 AI 容易在单次生成中产生遗漏或逻辑断层。
  3. 文档即版本控制 所有生成的 spec.mdplan.mdtasks.md 建议提交到 Git 仓库,作为项目演进的历史上下文进行保留与追踪。
  4. 验证需要闭环 Spec-Kit 负责到“代码生成完成”为止,它不包含运行时测试能力。对于 UI 或端到端验证(E2E),建议配合 Playwright、Shiplight 等测试框架形成质量闭环。


评论

暂无评论