别再给每个AI编码代理单独写规则了AGENTS.md一份配好全工具通用【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md昨天刚在Cursor里配好一套规则今天换到VS Code和Codex CLI打开同一个项目全部作废。更烦人的是代理干的第一件事就是跑错构建命令把开发服务器的热更新搞挂了。这就是AGENTS.md解决的问题把AI编码代理在你的项目上干活需要的说明放进一个统一、可预测的文件里换工具不用再重新解释。它到底在干嘛AGENTS.md就是给编码代理的一份工作手册。README是给人看的欢迎手册——项目介绍、快速上手AGENTS.md是给代理看的操作手册——怎么构建、怎么测试、遵守什么约定、哪里有坑。它只是普通的Markdown没有必填字段标题随你写代理干活时会自动读取。为什么一个文件能顶掉所有工具专属规则写一份配置全AI工具链都能读Codex、GitHub Copilot、VS Code、Cursor、Windsurf、Gemini CLI等主流编码代理都认这个文件名。这意味着什么你只写一次之后无论切到哪个工具代理第一天就知道怎么开发你的项目规则不浪费。就是普通Markdown没有任何学习成本没有必填字段没有schema没有专有格式也不绑定任何框架。这意味着什么第一版五分钟就能写完将来工具生态再怎么迭代你沉淀下来的规则也不会整体作废。把代理要的东西给它别污染README构建步骤、测试命令、安全注意事项这类内容塞进给人看的README里会把真正的介绍挤出第一屏。这意味着什么人读README代理读AGENTS.md各司其职两份文档都保持干净。第一份AGENTS.md怎么写不用一次写全顺序是先让代理能跑起来再让它跑得对最后让它不再犯同一个错。先建文件再填三条规则在仓库根目录新建AGENTS.md。想不出写什么时先让代理自己根据项目结构起草一份再删改——这步最省时间。先填三件事怎么构建、怎么测试、代码怎么写有约定。这是代理开工的最小上下文效果类似这样# 给AI编码代理的项目指南 ## 构建与测试 - 用 npm run dev 启动开发服务器开发会话中不要跑 npm run build - 提交前必须通过 npm run lint 和 npm run test ## 代码约定 - 新组件一律用 TypeScript - 组件样式和组件放在同一目录把你会告诉新同事的坑写进去然后写坑。比如本站自己的AGENTS.md里就有一条代理会话中不要跑npm run build因为生产构建会关掉热更新。提交信息的格式、锁文件怎么同步、部署步骤——任何你会向新入职同事交代的事都写进去。代理老犯同一个错写下来把这个文件当活文档。发现代理总做错某件事别在聊天里反复解释直接把正确做法写进文件提交掉。配置会随项目一起越来越准坑会越来越少。进阶玩法让配置适配大项目和团队如果你维护一个大型monorepo可以每个package下放一个独立的AGENTS.md。代理会自动读取目录树中最近的那份文件离被编辑文件最近的生效每个子项目都能带自己的约定指令冲突时也是离得近的赢。OpenAI主仓库现在就放着88份这样的文件。如果你已经有工具专属的规则文件可以把现有规则整合进AGENTS.md规则不作废只是换了个地方。Aider在.aider.conf.yml里加一行read: AGENTS.mdGemini CLI在.gemini/settings.json里指一下AGENTS.md都是一行配置的事旧文件留着做软链接也不会断。换AI工具那天你不用再重新解释一遍项目代理自己会读工作手册。想看一个现成样本从本仓库根目录的AGENTS.md读起几条命令说明就告诉代理怎么开发本站而不搞挂热更新写自己的时候可以直接照着抄。相关资源可直接抄的样本本站自己的代理开发手册AGENTS.md项目说明与最小AGENTS.md示例README.md支持的工具清单源码components/CompatibilitySection.tsx【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考