SuperAPI AI 工具集

claude-md-generator

编程与开发

查看项目

更新于 10-16 02:06

技能介绍

用途

CLAUDE.md Generator 用于从代码库扫描生成或更新项目的 CLAUDE 或 AGENTS 上下文文件。其定位是:读代码库,写出一份最精炼的 CLAUDE.md,告诉 Claude 它需要知道的信息,不多也不少。

主要能力

该技能支持三种运行模式:

  • create:项目中没有 CLAUDE.md,从零编写。
  • update:已存在 CLAUDE.md,在不丢弃自定义内容的前提下改进。
  • audit:对项目中所有 CLAUDE.md 文件按 A-F 评分并输出质量报告。当用户提到 audit、check、review 或 grade 自己的 CLAUDE.md 时运行审计模式。

两条关键规则:

  • 一份好的 CLAUDE.md 应少于 100 行,只包含 Claude 无法从代码本身推断出的信息。
  • 不要自动写文件,始终先展示草稿并等待用户批准。
  • 不要在 CLAUDE.md 中包含内联代码示例,改用 file.ts:42 引用形式,因为内联代码会浪费 token 并且容易过时。

审计模式使用以下评分标准:命令(构建/测试/lint 命令是否存在且可运行)、架构(非显而易见的结构是否解释清楚)、非显而易见的模式(gotchas、生成文件、环境变量顺序是否有记录)、简洁性(是否少于 100 行、是否无冗余填充)、时效性(命令是否仍与当前 package.json/Makefile 匹配)、可操作性(新贡献者能否不提问就跟随执行)。评分为 90-100 = A,70-89 = B,50-69 = C,30-49 = D,0-29 = F。

使用方式

  1. 检测模式:判断运行 create、update 还是 audit。若发现多个 CLAUDE.md 文件,会列出它们并询问是更新全部还是仅根目录。
  2. 审计模式(create/update 可跳过):对每个 CLAUDE.md 评分并以表格形式输出报告,附带问题清单,然后询问是否修复。
  3. 扫描项目结构:检测项目类型与包管理器,列出顶层目录结构。
  4. 提取构建与测试命令:从 package.json 脚本、Makefile、go.mod、Cargo.toml 中识别 build、test、单文件测试、dev server、lint/typecheck 的精确命令,并记录运行所需的环境变量。
  5. 查找代码风格与 gotchas:检测导入别名、必需的环境变量、自动生成文件(不可编辑)、测试配置、数据库/迁移设置。gotchas 仅包含:自动生成文件、测试运行前所需的环境变量、非默认导入别名映射、需要运行服务的测试命令、已知的有意为之的怪癖。
  6. 使用 Gemini 生成 CLAUDE.md 草稿:将发现汇总,通过 curl 调用 Gemini API 生成,温度 0.3,最大输出 token 2048。对于大型项目(50+ 文件),在底部添加 @path 指针并写入 docs/ai-context/ 目录。
  7. 自我 QA:检查是否少于 100 行、是否无内联代码示例、命令是否可原样运行、gotchas 是否至少有一条真实条目、是否有非显而易见内容、是否无 em dash、是否无营销词或填充语、导入别名是否记录、自动生成文件是否标记不可编辑。
  8. 展示草稿并等待批准:在代码块中展示草稿与行数,询问写入/先编辑/取消。用户同意后写入并确认。

排除项:语言/框架版本、框架工作原理、全部依赖列表、linter 已强制执行的风格规则、与 README 重复的内容、内联代码示例、任何对同一技术栈项目都相同的内容。

适用场景

适用于需要为软件项目创建或维护面向 AI 编码助手的精简上下文文件的场景,例如为新项目生成 CLAUDE.md、改进已有文件、批量审计项目中所有 CLAUDE.md 的质量。

限制

调用 Gemini 生成草稿需要 GEMINI_API_KEY 环境变量。写入文件前必须获得用户批准。其他收费、价格、平台或效果信息暂未提供。