AGENTS.md(AI 编码代理指令文件标准)
官方介绍
AGENTS.md 是一个用于指导 AI 编码代理的开放文件格式:一个放在代码仓库根目录的 Markdown 文件,相当于「写给 AI 看的 README」。它集中存放 AI 开工前需要知道的项目上下文——构建与测试命令、代码风格、目录约定、安全注意事项等,AI 编码代理每次开工自动先读它再动手。该格式由 OpenAI Codex、Amp、Google Jules、Cursor、Factory 等共同推出,目前已被 6 万多个开源项目采用,现由 Linux 基金会旗下的 Agentic AI Foundation 负责维护。
核心功能
- 一份文件适配多个工具:Codex、Cursor、Gemini CLI、GitHub Copilot、Devin、Windsurf、Aider、Zed 等 20 多款 AI 编码工具均支持读取
- 无必填字段:就是标准 Markdown,标题结构随意,代理直接解析文本
- 支持嵌套:monorepo 仓库可在每个子包放各自的 AGENTS.md,离被修改文件最近的文件优先
- 指令冲突规则:离被修改文件最近的 AGENTS.md 优先;用户在对话中的显式指令覆盖一切
- 代理会自动执行文件中列出的测试与检查命令,并在完成任务前修复失败项
使用说明
- 在仓库根目录创建 AGENTS.md(多数编码代理可以代为生成)
- 写入关键章节:项目概览、构建与测试命令、代码风格、测试说明、安全注意事项
- 按需补充:提交信息与 PR 规范、部署步骤、安全红线等「会告诉新同事的一切」
- 大型 monorepo 在子目录放置嵌套的 AGENTS.md,为子项目定制指令
同类机制:Claude Code 使用 CLAUDE.md 承载项目规范;Codex、Cursor 等工具则直接读取 AGENTS.md。二者思路一致——项目规矩写进固定文件,AI 开工自动先读。