AGENTS.md 快速上手指南一份 Markdown 文件让 AI 编程代理按你的规矩干活【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.mdAGENTS.md 是一个简单的开源 Markdown 格式专门用来给 AI 编程代理coding agent交代这个项目该怎么干——可以把它理解成一份写给 AI 的 README。目前已有超过 6 万个开源项目在使用。下面不讲大道理直接告诉你它解决什么问题、里面该写什么、三步就能用起来。先说个真实事故AI 把开发环境搞坏了这个仓库本身就是一个 Next.js 网站而它自己的 AGENTS.md 里记录了一条血泪教训有段时间AI 代理在交互会话里顺手执行了npm run build结果.next目录被切换成生产构建产物热更新直接失效开发服务器陷入混乱状态修复方式只有一句话禁止在代理会话中运行生产构建生产打包要放到会话外去做这类只有踩过坑才知道的细节写在 README 里太占地方写在聊天记录里又会丢。AGENTS.md 就是为它们准备的固定位置——代理每次开工前都会去读从此不再重蹈覆辙。AGENTS.md 是什么写给 AI 代理的 README本质一份放在仓库里的标准 Markdown 文件没有必填字段、没有固定结构代理直接解析你写的文本定位README.md 面向人类读者AGENTS.md 补充代理真正需要的上下文——构建步骤、测试命令、代码约定作用给代理一个清晰、可预期的指令来源让它交付的代码符合项目规范而不是只语法正确来头由 OpenAI Codex、Google Jules、Cursor、Factory 等多个团队共同推动现已交由 Linux 基金会旗下的 Agentic AI Foundation 维护AGENTS.md 里写什么五类高频内容官方给出的示例文件见 README 里的完整例子基本覆盖了所有高频场景你可以照着挑环境准备命令装依赖、起服务、跑测试各是什么命令测试说明测试配置在哪、怎么只跑单条用例、提交前必须全绿代码风格约定比如TypeScript 严格模式单引号、不加分号PR 规范标题格式、提交前必须跑lint和test其他叮嘱安全注意事项、部署步骤、大文件位置——凡是你会告诉新伙伴的事都可以写进去一个小提示代理会自动执行你在文件里列出的检查命令并尝试修复失败项直到通过。所以列出的命令要确实可靠。三步创建 AGENTS.md最快上手路径在仓库根目录新建AGENTS.md直接让 AI 代理帮你起草即可大多数代理都乐意干这个活补上最关键的内容先写构建/测试命令和代码风格其余的用到再补大仓库用嵌套文件每个子包放一份自己的AGENTS.md代理会自动读取离被编辑文件最近的那份就近优先。OpenAI 主仓库目前就放了 88 份两条规则帮你理清优先级指令冲突时离文件最近的 AGENTS.md 说了算你在对话里的明确指令永远最高覆盖一切文件内容一份最小可用的示例感受一下够用就好的分寸# AGENTS.md ## 常用命令 - 安装依赖pnpm install - 启动开发服务pnpm dev - 运行测试pnpm test ## 代码风格 - TypeScript 严格模式 - 函数式写法优先哪些 AI 编程工具支持 AGENTS.md一份文件跨工具通用。当前已支持的工具包括详见 官网兼容列表源码OpenAI Codex、GitHub Copilot、Cursor、VS CodeGoogle的 Jules 与 Gemini CLICognition的 Devin、WindsurfZed、Aider、goose、Roo Code、Kilo Code、opencode、Phoenix、Warp、JetBrains Junie、Semgrep等 20 多个工具个别工具需要一行配置才能指向这个文件Aider在.aider.conf.yml里加read: AGENTS.mdGemini CLI在.gemini/settings.json的context.fileName里填AGENTS.mdAGENTS.md 常见问题迁移与更新已有 AGENT.md单数怎么办重命名为AGENTS.md再建一个符号链接保持兼容即可能改吗随时能改。把它当成活的文档项目变了就顺手更新想让 AI 帮你从零开始在代理会话里直接说为这个项目生成一份 AGENTS.md多数代理会先读代码再起草想看真实范例直接看本仓库根目录的 AGENTS.md它管的就是这个网站本身官网源码 是 Next.js 应用里面别在生产构建里动开发服务器这类规则就是实战产物收尾今天就能做的一件事不用追求一次写完美——先建文件再填命令最后补约定。把最容易让 AI 跑偏的两三件事写进去构建命令、测试命令、一条禁令你就已经超过了大多数还没做这一步的项目。AI 代理的智商再高也不如给它一张写清楚的操作说明书。【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考