AGENTS.md - 一种简单的开放格式，用于指导编码代理

AGENTS.md 是一种简单的开放格式，旨在指导编码代理，已被超过 20,000 个开源项目使用。它作为一个专门的空间，提供上下文和指令，帮助 AI 编码代理有效地进行项目工作。该格式通过关注编码代理的特定需求，补充了传统的 README.md 文件。

1. 设置命令

   • 安装依赖：pnpm install
   • 启动开发服务器：pnpm dev
   • 运行测试：pnpm test

2. 代码风格指南

   • TypeScript 严格模式
   • 单引号，不使用分号
   • 偏好函数式编程模式

3. 代理兼容性

   AGENTS.md 与各种 AI 编码代理无缝兼容，包括：

   代理名称	描述
   Codex	用于 AI 编码代理的通用 CLI 工具。
   Amp	来自 Google 的 AI 编码代理。
   Jules	另一个来自 Google 的 AI 编码代理。
   Cursor	提高生产力的 AI 编码工具。
   Factory	用于构建和管理编码代理的工具。
   Roo	用于各种编程任务的 AI 编码助手。
   CodeAider	用于代码辅助和生成的 AI 工具。
   Gemini CLI	来自 Google 的编码任务 CLI 工具。
   Kilo Code	用于简化开发的 AI 编码代理。
   OpenCode	用于协作项目的开源编码代理。
   Phoenix	用于提高编码效率的 AI 工具。
   Zed	用于各种编程语言的 AI 编码助手。

4. 嵌套 AGENTS.md 文件

   对于大型单体仓库，可以在子项目中使用嵌套的 AGENTS.md 文件，为每个包提供量身定制的指令。

1. 在您的代码库根目录创建一个 AGENTS.md 文件。
2. 包含帮助代理有效工作的部分，例如项目概述、构建命令和测试指令。
3. 添加与新贡献者相关的任何额外指令，例如提交消息和安全考虑。
4. 对于大型项目，利用嵌套的 AGENTS.md 文件为特定子项目提供本地化指导。

AGENTS.md 中是否有必填字段？

没有，AGENTS.md 是灵活的，可以根据需要使用任何标题进行结构化。代理将解析提供的文本。

如果指令冲突会发生什么？

离编辑文件最近的 AGENTS.md 文件优先，而明确的用户提示将覆盖任何冲突的指令。

代理会自动运行测试命令吗？

是的，如果在 AGENTS.md 中列出了测试命令，代理将尝试执行它们并修复任何失败。

AGENTS.md 可以在以后更新吗？

当然，AGENTS.md 应被视为可以根据需要修改的动态文档。

价格数据尚不可用；请访问官方网站以获取更多信息。

1. AGENTS.md 有效地为编码代理提供了结构化格式，增强了它们理解项目需求和高效执行任务的能力。
2. 与 README.md 文件的分离有助于保持人类贡献者的清晰性，同时为 AI 代理提供详细指导。
3. 然而，采用 AGENTS.md 可能需要团队在传统文档实践中进行文化转变。
4. 总体而言，AGENTS.md 是开发人员希望通过 AI 编码代理简化工作流程的宝贵工具，但其成功依赖于一致的使用和更新。