用途:为任意项目生成或改进 CLAUDE.md、AGENTS.md 等 agent 指令文件,把项目信息整理成 agent 可执行的操作手册。
主要能力与流程:
- 分析项目:扫描根目录,收集命令(package.json scripts、Makefile、pyproject.toml、Cargo.toml、go.mod)、测试(jest/vitest/pytest 配置与 test 目录)、项目结构、代码风格(eslint/prettier/ruff/.editorconfig 及近期 commit)、Git 工作流(近期 commit message 与分支命名)、边界(.gitignore、CI 配置、敏感文件)等信息,并输出分析摘要给用户确认。大型项目额外扫描 docs/、ADR/、specs/,monorepo 子包与 CI/CD 配置。
- 生成 CLAUDE.md:包含固定 section——项目名与一句话技术栈说明、常用命令、写代码时(架构约束与代码风格示例)、完成标准(命令加期望退出码)、卡住时(场景与操作)、参考文档(可选)。
- 生成 AGENTS.md:内容为指向 CLAUDE.md 的引用行。
- 输出与确认:展示 CLAUDE.md 供 review,确认后写入;已有文件则展示 diff 再确认覆盖。
文档原则:命令优先;用代码片段代替文字描述;精简在一百行以内,上限二百;只写 agent 推断不出的内容;区分必须做、先问、绝不做;随 agent 犯错持续补充规则。资料中给出 Next.js 与 Python 的示例输出。
限制:需先经用户确认才写入文件;未提供具体安装与运行命令、支持的平台范围、收费或价格信息。