5分钟上手 AGENTS.md让所有 AI 编码助手按同一套规矩干活【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md如果你在用 Cursor、Copilot 或 Codex 这类 AI 编码助手大概率遇到过这种情况代码写得飞快却总用错构建命令、改挂测试、提交格式五花八门。AGENTS.md 就是为此而生的——一个简单开放的格式专门用来告诉 AI 编码助手这个项目该怎么干活目前已有超过 60000 个开源项目在使用它。 先说痛点AI 助手乱改代码的根源每个 AI 助手接手项目都像刚入职的新员工不知道测试命令是什么、代码风格怎么要求、PR 标题该用什么格式这些知识往往只存在于口口相传或团队 Wiki 里AI 根本读不到只能靠猜。结果就是同一个仓库五个人的 AI 输出五种风格AGENTS.md 的做法很直接把这些信息集中写在仓库根目录的一个 Markdown 文件里所有兼容的 AI 助手都会主动去读它相当于给 AI 定了一份入职须知 三步在仓库里落地 AGENTS.md新建文件把仓库克隆到本地git clone https://gitcode.com/GitHub_Trending/ag/agents.md在根目录创建 AGENTS.md写关键内容不用追求一次写全参考这个最小可用示例先覆盖最痛的部分提交共享随代码一起提交团队成员和 AI 助手拿到仓库就自动获得上下文# AGENTS.md ## Build test - Install deps with pnpm install - Run pnpm test before every commit ## Code style - Use TypeScript, 2-space indent ## PR rules - Title format: [module] Summary 写什么最实用4 类内容优先内容没有固定模板但下面四类是投入产出比最高的构建与测试命令装依赖、跑测试、跑 lint 的具体命令这是 AI 最常猜错的部分代码风格约定语言偏好、缩进规则、文件组织方式提交与 PR 规范标题格式、合并前必须通过的检查安全与禁区哪些目录不能动、哪些命令禁止执行。这个仓库自己的 AGENTS.md 就写得很具体AI 会话期间只许跑开发服务器禁止执行生产构建因为它会破坏热更新 大型仓库进阶嵌套文件 就近优先在 monorepo 里每个子包目录可以再放一个 AGENTS.mdAI 助手会自动读取离被编辑文件最近的那份每个子项目都能有各自的细则冲突时的优先级规则很简单离文件最近的 AGENTS.md 说了算而你在对话里明确给出的指令永远压过一切实际参考OpenAI 的官方仓库里就维护着 88 个 AGENTS.md 文件❓ 新手最常见的 4 个疑问有必填字段吗没有。它只是普通 Markdown用什么标题都随意AI 负责理解内容而不是校验格式写了测试命令AI 会自己跑吗会。只要你列出来了助手会尝试运行相关检查并把报错修到通过再交差项目变了要重写吗不用。它本来就是活文档随项目节奏小步更新即可换了新工具要重新配置吗大部分主流工具开箱即读少数工具如 Aider、Gemini CLI只需在各自配置里加一行指定读取 AGENTS.md 就能接入AGENTS.md 的价值不在文件本身有多复杂而在于把只有老员工才清楚的项目知识变成了所有 AI 助手都能读懂的标准上下文一次编写全团队复用。下一步很简单打开你正在维护的仓库新建一个 AGENTS.md先写上最常用的 3 条命令再让 AI 助手跑一轮测试验证效果。【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考