Skip to content

5 分钟快速上手

本文帮你在 5 分钟内跑通「安装 → 触发 dev-flow → 完成一次开发」的最小闭环。

第 1 步:安装(1 分钟)

bash
git clone <your-repo-url> ~/ai-coding-kit
cd ~/ai-coding-kit/skills/dev-flow/dist
bash install.sh

安装完成后,~/.codebuddy/ 下即拥有 15 个 Skill、2 条核心规则和 10 个 Agents。详见 安装与配置

第 2 步:触发 dev-flow(1 分钟)

dev-flow 仅由显式命令触发,AI 不会基于关键词自作主张启动。在对话中输入:

dev-flow

或直接带上你的需求:

dev: 给登录页加一个「记住我」勾选框

也支持轻量模式:

命令适用场景
dev-flow / dev:标准流程(阶段 0 + 步骤 1~10)
dev-flow --micro微改动(≤3 文件、≤10 行/文件、位置明确)
dev-flow --fast快速模式

第 3 步:跟随流程(3 分钟)

dev-flow 会引导你走完系统化流程:

  1. 阶段 0 · 需求理解 — 澄清需求,不确定点汇总确认(禁止猜测)。
  2. 步骤 1~3 · 研究分析 — 探索代码、定位影响范围、制定方案。
  3. 步骤 4 · 方案决策 — 智能评估推荐执行深度(标准 / 完整 / 分批)。
  4. 步骤 5 · 编码 — 最小入侵实现,遵守 12 条核心红线。
  5. 步骤 5.5 · 自检 — L1 代码审查 + 文档同步 + ESLint 自检。
  6. 步骤 6~10 · 验证与交付 — 自动化验证、提交信息生成、经验沉淀。

每一步都有门控(gate)保障质量,关键步骤由 step-gate Agent 做完整性审计。

常用命令速查

命令作用
dev:status / dev:st查看当前流程状态
dev:kb / dev:k代码知识库操作
dev:metrics / dev:m查看开发度量
dev:onboard / dev:ob新人上手引导

下一步

基于「单一权威源」哲学构建 —— 文档由源文件投影生成