三、快速上手

当前 CodeBuddy IDE  和 CodeBuddy Code 都已支持 Spec-kit ,通过自定义指令 / 能力实现 Spec Coding,如下为快速入门上手,可根据需要进行选择对应的 CodeBuddy  形态工具使用。

3.1 环境准备

1.安装 CodeBuddy IDE 或 CodeBuddy Code

# 安装 codebuddy-code 依赖 node  和 npm,可通过下面指令安装
https://nodejs.org/en/download/

 # 安装 codebuddy-code,通过 iOA  登录,如无权限或未识别 iOA,腾讯用户选择 sso,输入 tencent 即可
https://copilot.tencent.com/ide/

 #  本地终端安装 codebuddy-code 
npm install -g @tencent-ai/codebuddy-code
 

2.在 Unix 系统中终端执行命令安装 Specify CLI

# 方式 1:持久化安装(推荐)
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
 
# 方式 2:一次性使用
uvx --from git+https://github.com/github/spec-kit.git specify init my-project

3.选择工具:以 CodeBuddy 为例进行选择和 Enter 确认

4.报错解决:原因是缺乏拉取 Github API ,无法拉取代码

5.申请 Github 令牌:

https://github.com/settings/personal-access-tokens

6.在操作系统中配置令牌

# 进行导入配置变量,其中/root/.bashrc 为 Linux 系统本机的变量位置,如在 Mac 安装,默认地址为 ~/.zshrc  或 ~/.bashrc。
export GH_TOKEN='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' & export GITHUB_TOKEN="$GH_TOKEN" >> /root/.bashrc
 
  source  /root/.bashrc

3.2 初始化项目

# 使用 CodeBuddy 进行项目初始化
specify init my-project

初始化过程,主要执行如下步骤:主要是下载模版安装包、解压和 Git  仓库初始化

初始化后提供一些命令, 输入 CodeBuddy ,即在 CodeBuddy Code中 使用了

初始项目之后,可以看到主要创建一下文件

3.3 检查环境

进入 CodeBuddy Code 之中,进行 输入/spec  可以看到核心指令

3.4  建立项目宪法

命令:/speckit.constitution
作用:创建项目的"宪法",这些原则和指南会指导所有后续的开发工作。

示例输入:以新项目为例

/speckit.constitution 这是一个 Nextjs 框架的问卷调研系统

 AI 生成的原则示例:
- 所有数据只存本地,采用 Mock 的方式,不上传云端,计算过程透明
- 面向普通用户,交互简单直观
- 每个功能都能独立测试、渐进上线

示意图:生成项目宪法

示意图:项目宪法完成生成

PS: 如果是存量业务系统,可以直接输入 /constitution  使用 AI 进行生成。

3.5  描述功能需求

命令:/speckit.specify
作用:输出产品需求文档(PRD)
核心原则:只描述"要什么",不讨论"怎么实现"

示例输入:

/speckit.specify 我要做一个问卷系统。
 参考腾讯问卷,至少支持问卷新建、删除。
UI 设计要有活力感一点。
当完成问卷生成后,给一个大大的鼓励动画。

示意图:进行需求分支创建和用户故事输出

示意图:进行需求验证

3.6  澄清需求细节(可选)

命令:/speckit.clarify
作用:Spec-Kit 开始针对需求不明确的点,向我们提问
无需额外输入,直接执行即可:

示例输入:

/speckit.specify 进行需求澄清,有无不足或未考虑到的地方

执行/clarify  后,执行后会提出五个问题,我们按自己的需求回答清楚就好。

示例图:进行需求澄清

示例图:规约驱动引导人进行决策

3.7 确定技术方案和生成实施计划

命令:/speckit.plan
作用:基于需求写技术方案和实施计划
无需额外输入,直接执行:

基于上述需求澄清,接下来执行生成项目实施计划

用户输入:

/speckit.plan 执行

示例图:需求澄清确认

示例图:引导下步行动

3.8 拆解执行任务

命令:/tasks 
作用:拆解任务,分析 spec.md 和 plan.md、按阶段(Phase)拆解为多个子任务、每个任务包含明确的验收标准、估算完成时间
基于需求和技术方案,拆解出具体的任务无需额外输入,直接执行

用户输入

/speckit.tasks - 生成详细任务列表

执行完成后,可以看到基于需求和技术方案,拆解出了 79 个任务,预计要执行3-4 周,并输出示例(tasks.md):

点到 task 文档里看一眼,所有任务的代办列表都一清二楚。

3.9 全面审核(可选但推荐)

命令:/analyze
作用:将所有文档全部审核一遍,检测 spec.md、plan.md 和 tasks.md 之间的不一致性、重复、歧义和欠指定项,将有问题的点全部找出来,生成报告并协助修复。
场景:通过前面这几步可以看到 spec-kit 已经给我们生成了茫茫多的文档。很难保证这些文档完全没有问题
无需额外输入:

用户输入

/analyze  进行全面分析

示意图:全面分析结果

3.10 开始写代码

命令:/implement
作用:开始写需求代码
使用方式: /implement ,AI 会按顺序执行 tasks.md 中的每个任务、每执行完一个任务 spec-kit 都会到我们的 task 文档里边打个勾、遇到测试失败会自动修复,最后所有任务完成后提示用户

用户输入

/speckit.implement  开始写代码

实时进度可视化,建议开启 YOLO 模式,全程托管,不然中间会有确认环节流程会被打断