用途:按 agents.md 约定生成并维护 AGENTS.md 文件,也可用于 .github/copilot-instructions.md 等 AI 智能体规则文件;AGENTS.md 面向智能体而非人类,用于让 AI 智能体快速了解陌生代码库、统一多仓库的智能体文档。
主要能力:提供多个脚本。generate-agents.sh PATH 生成文件;validate-structure.sh 校验结构合规;check-freshness.sh 检查是否过时;verify-content.sh 与 verify-commands.sh 校验文档中的文件、命令是否与代码库一致;detect-project.sh 检测语言、版本与构建工具;detect-scopes.sh 识别需要局部文件的目录;extract-commands.sh、extract-ci-rules.sh、extract-version-matrix、extract-architecture-rules.sh、extract-adrs.sh、extract-github-rulesets.sh 提取命令、CI 质量门禁与版本矩阵、模块边界、架构决策记录、GitHub 规则集与合并规则。
使用方式:按“检测—提取—生成—校验”流程操作。先用 detect-project.sh 与 detect-scopes.sh 识别技术栈与子系统;再用各 extract 脚本收集事实;然后用 generate-agents.sh 生成,--style=thin 为默认,也支持 --verbose;最后必须用 verify-content.sh 与 verify-commands.sh 验证。--update 可保留 <!-- GENERATED --> 标记之外由人工整理的内容。默认自动创建 CLAUDE.md/GEMINI.md 符号链接。
原则与限制:结构化优于散文,不虚构,只记录实际存在的内容并验证每个命令与路径;指向文件而非复制内容。模板含根文件与局部文件(如 backend-go、python-modern、frontend-typescript 等),支持 Go、PHP(Composer/Laravel/Symfony/TYPO3/Oro)、TypeScript(React/Next/Vue/Node)、Python(pip/poetry/ruff/mypy)、技能仓库与多栈混合项目。收费、价格、平台与具体使用步骤等资料暂未提供,详见 references/scripts-guide.md 与 examples/。