1 关于AGENTS.md

将AGENT.md视为智能体的README文件：一个专门的、可预测的用于提供上下文和指令的地方，帮助AI编码智能体的项目工作。

2 为什么需要AGENTS.md

README.md文件是为人类准备的：快速入门、项目描述、贡献指南。

AGENTS.md对READ.md文件的补充，其中包含了额外的、有时是详细的编码智能体需要的上下文：构建步骤、测试，以及可能导致README文件杂乱或与人工贡献者无关的约定。

我们特意将README.md和AGENTS.md分开，以便：

• 为智能体提供一个清晰、可预测的指令接收平台。
• 保持README文件的简洁性，并重点关注人类贡献者。
• 提供精确，以智能体为中心的指导，作为对现有README和文档的补充。

并非是引入另一种专用文件，而是选择了一种对任何人都有用的名称和格式。如果你正在构建或使用编码智能体，并且觉得这很有帮助，请随意采用它。

3 单AGENTS.md多智能体

你的智能体定义要与不断发展的AI编码智能体和工具生态系统兼容，AGENTS.md兼容的智能体如下：

4 如何使用AGENTS.md

4.1 添加AGENTS.md

在代码仓库根目录创建AGNETS.md文件。如果提问精确，大多数编码智能体甚至可以为你搭建一个。

4.2 聚焦重要事件

添加有助于智能体有效处理项目的章节，热门选择包括：

1. 项目概述
2. 构建和测试命令
3. 编码风格指南
4. 测试指令
5. 安全事项

4.3 添加额外指令

代码提交信息或拉取请求指南、安全陷阱、大型数据集、部署步骤。任何你想告诉新队友的内容也放这里。

4.4 大型单体仓库？针对子项目使用嵌套的AGENTS.md文件

在每个包中再放一份AGENTS.md文件，即每个代码包都有属于自己的AGENTS.md，而非整个项目只用一个根目录的AGENTS.md。

智能体会自动读取目录树中最靠近的文件，即与编译和测试代码最近的AGENTS.md。因此，最近的AGENTS.md文件具有优先权，每个子项目都可以推出定制指令。例如，OpenAI的主仓库中有88个AGENTS.md文件。

5 常见问题

1）是否有必填项？

没有。AGENTS.md是个标准的Markdown文件。使用任何你喜欢的标题，智能体只简单的解析你提供的文本。

2）如果指令冲突怎么办？

与已编辑文件最近的AGENTS.md文件将获胜；明确的用户聊天提示将覆盖所有其他内容。

3）智能体会自动运行AGENTS.md中的测试命令吗？

会的。如果你列出来，智能体将在完成任务之前尝试执行相关程序化检查并修复故障。

4）我可以更新吗？

完全可以。将AGENTS.md看成是实时文档。

5）何在Gemini CLI中配置？

在.gemini/settings.json中添加配置信息：

{ "context": { "fileName": "AGENTS.md" }, }