用途 agents-md-cookbook 提供一套经过测试、工具无关的 AGENTS.md 工具包。AGENTS.md 是放在仓库根目录的一份 Markdown 文件，用来告诉编码代理如何构建、测试和在项目中工作。据资料，该标准由 Linux Foundation 的 Agentic AI Foundation 管理，已存在于 60,000+ 仓库，并被 24+ 工具原生读取。
主要能力
- 提供按技术栈划分的 15 个模板，每个模板都是一份完整、可复制粘贴的 AGENTS.md。
- 提供工具兼容性矩阵，说明不同代理工具对 AGENTS.md 的支持情况。
- 提供 npm CLI 与 GitHub Action 形式的 linter：agents-md-lint，用于对 AGENTS.md 评分并在 CI 中因回归而失败。
- 提供迁移工具 agents-md-migrate，可将已有的 CLAUDE.md、.cursorrules、GEMINI.md 等转换为干净的 AGENTS.md。
- 仓库自身在 CI 中对自有模板运行 agents-md-lint（dogfooding）。
使用方式
-
复制模板： curl -fsSL
https://raw.githubusercontent.com/Taiizor/agents-md-cookbook/main/templates/typescript-node/AGENTS.md
-o AGENTS.md 文件名必须完全为 AGENTS.md（大写 AGENTS，小写 .md）。其他技术栈可浏览完整模板索引。 -
迁移已有配置： bunx agents-md-migrate
或：npx agents-md-migrate
该命令会检测 CLAUDE.md、.cursorrules、GEMINI.md 等文件，并生成单个 AGENTS.md。该工具由 agents-md-migrate 包发布。
- 在 CI 中 lint：
.github/workflows/ci.yml
- name: Lint AGENTS.md run: bunx agents-md-lint AGENTS.md
或：npx agents-md-lint AGENTS.md
也可使用仓库内置的 action.yml 作为一行式 GitHub Action：
.github/workflows/ci.yml
- uses: Taiizor/agents-md-cookbook@v1 with: path: AGENTS.md
这两个 CLI 位于 packages/ 下，由单独的发布计划发布，可通过 bunx 或 npx 运行，无需安装。
适用场景
- 需要在多个编码代理工具（如 Cursor、Codex、Copilot、Windsurf、Cline、Zed、Jules、Amp 等）之间共用同一份项目指令。
- 希望把分散的 .cursorrules、CLAUDE.md、Copilot、Windsurf、Cline、Aider 等配置统一迁移为 AGENTS.md。
- 希望在 CI 中持续校验 AGENTS.md 的准确性与结构。
- 面向 monorepo、需要嵌套或回退机制的项目（详见 COMPATIBILITY.md）。
限制与注意事项
- AGENTS.md 文件名必须完全为 AGENTS.md，大写 AGENTS、小写 .md。
- 模板刻意保持简短（资料提到 60-150 行），以命令优先、真实代码片段、明确边界为原则；不鼓励冗长架构文章与 token 膨胀。
- 关于定价、收费、具体平台支持状态、具体效果数据、完整功能列表等，资料中暂未提供，需以仓库实际文档与代码为准。
- 兼容性矩阵、嵌套行为、自身文件回退与来源说明见 COMPATIBILITY.md，其中包含带日期的最后验证行。
补充说明 资料提到模板设计参考了 GitHub 对 2,500+ 仓库的研究、ETH Zurich 的 AGENTbench、Augment 的 golden-PR 评估等证据；但具体研究结论引用在此不展开。仓库为 MIT © 2026 Taiizor。
