5分钟上手 AGENTS.md一份配置全公司 AI 编码工具通用【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md换了编辑器规则就丢了Cursor 用 .cursorrulesAider 用 .aider.conf.yml各家一套写法。工具一换就得重写规则还容易散落在个人目录里。AGENTS.md 是解决这件事的开放格式把 AI 编码代理的行为规则写进一个 Markdown 文件大量主流工具开箱即读。为什么不用 README 直接写 AI 规则README 面向人AGENTS.md 面向代理README 负责快速开始和项目介绍。但代理需要的构建步骤、测试入口、坑点说明塞进 README 会把它撑得很臃肿有些细节对人类贡献者也没什么用。AGENTS.md 给代理留了一个专属位项目说明保持干净AI 规则单独放一份。没有必填字段标准 Markdown 就行它没有固定 schema就是一个普通 Markdown 文件标题随便你组织代理按你写的文本解析。也正因为不带任何厂商锁Codex、Cursor、VS Code、Gemini CLI、Copilot 等 20 多款工具都能直接读取同一份文件。写出第一份最小 AGENTS.md四个板块就够可直接套用的最小模板# AGENTS.md ## 命令 - 安装依赖pnpm install - 启动本地pnpm dev不要跑生产构建 ## 代码风格 - 新代码用 TypeScript - 提交前跑 pnpm lint ## 测试 - 提交前跑 pnpm test全部通过才算完成 ## 约束 - 不要动生产配置相关文件命令、风格、测试、约束四块覆盖大部分日常场景。先照抄一份再换成项目里真实的命令。缺什么补什么PR 规范、部署步骤官方的建议很直白凡是你会告诉新同事的事都可以写进去。commit message 格式、PR 标题约定、部署步骤、大文件的处理注意事项都属于这一类。和 .cursorrules、AGENT.md 共存怎么平滑迁移先改名再用软链接兼容仓库里已有 AGENT.md 之类的文件改名为 AGENTS.md再给旧路径留个软链接即可mv AGENT.md AGENTS.md ln -s AGENTS.md AGENT.md不用重写内容旧引用继续生效。不默认读取的工具加一行配置多数工具开箱识别 AGENTS.md个别工具要在自己的配置里指一下# .aider.conf.yml read: AGENTS.md # .gemini/settings.json { context: { fileName: AGENTS.md } }这是多工具共存时最主要的行为差异有的自动加载有的要显式指向配一次就不用再管。Monorepo 场景一份文件还是多份子包各放一份就近生效在每个子包里再放一个 AGENTS.md代理会自动读取离正在编辑的文件最近的那一份。大规模案例也有OpenAI 主仓库当时就有 88 份这样的文件。规则冲突时谁说了算两份文件规则打架时离被编辑文件最近的那份生效你在对话里给的实时指令优先级最高覆盖文件内容。所以全局写通用约束、敏感目录写严格规则这种分层是安全的。能写什么、不能写什么测试命令列进去代理会替你跑文件里列出测试命令后代理会在收尾前尝试运行相关检查并修复失败项。因此只写你愿意让它自动执行的命令危险的命令要显式标注禁止。本仓库自己的 AGENTS.md 就是例子它明确告诉代理只用 dev server、不要跑生产构建。敏感信息别写进配置 ⚠️这份配置会跟着仓库的可见范围走里面的 API key、内网地址、账号凭据等于直接公开。约束和规则写进去密钥留给环境变量或私有配置。全团队共用把配置放进版本管理当作活文档来维护AGENTS.md 随时可以更新。命令变了、架构重构了就同步改配置放进版本管理像评审其他文档一样在 PR 里过一眼。今晚挑一个你迭代最频繁的项目把第一版 AGENTS.md 提交进仓库队友克隆下来就能直接继承。【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 5分钟上手 AGENTS.md：一份配置，全公司 AI 编码工具通用
5分钟上手 AGENTS.md一份配置全公司 AI 编码工具通用【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md换了编辑器规则就丢了Cursor 用 .cursorrulesAider 用 .aider.conf.yml各家一套写法。工具一换就得重写规则还容易散落在个人目录里。AGENTS.md 是解决这件事的开放格式把 AI 编码代理的行为规则写进一个 Markdown 文件大量主流工具开箱即读。为什么不用 README 直接写 AI 规则README 面向人AGENTS.md 面向代理README 负责快速开始和项目介绍。但代理需要的构建步骤、测试入口、坑点说明塞进 README 会把它撑得很臃肿有些细节对人类贡献者也没什么用。AGENTS.md 给代理留了一个专属位项目说明保持干净AI 规则单独放一份。没有必填字段标准 Markdown 就行它没有固定 schema就是一个普通 Markdown 文件标题随便你组织代理按你写的文本解析。也正因为不带任何厂商锁Codex、Cursor、VS Code、Gemini CLI、Copilot 等 20 多款工具都能直接读取同一份文件。写出第一份最小 AGENTS.md四个板块就够可直接套用的最小模板# AGENTS.md ## 命令 - 安装依赖pnpm install - 启动本地pnpm dev不要跑生产构建 ## 代码风格 - 新代码用 TypeScript - 提交前跑 pnpm lint ## 测试 - 提交前跑 pnpm test全部通过才算完成 ## 约束 - 不要动生产配置相关文件命令、风格、测试、约束四块覆盖大部分日常场景。先照抄一份再换成项目里真实的命令。缺什么补什么PR 规范、部署步骤官方的建议很直白凡是你会告诉新同事的事都可以写进去。commit message 格式、PR 标题约定、部署步骤、大文件的处理注意事项都属于这一类。和 .cursorrules、AGENT.md 共存怎么平滑迁移先改名再用软链接兼容仓库里已有 AGENT.md 之类的文件改名为 AGENTS.md再给旧路径留个软链接即可mv AGENT.md AGENTS.md ln -s AGENTS.md AGENT.md不用重写内容旧引用继续生效。不默认读取的工具加一行配置多数工具开箱识别 AGENTS.md个别工具要在自己的配置里指一下# .aider.conf.yml read: AGENTS.md # .gemini/settings.json { context: { fileName: AGENTS.md } }这是多工具共存时最主要的行为差异有的自动加载有的要显式指向配一次就不用再管。Monorepo 场景一份文件还是多份子包各放一份就近生效在每个子包里再放一个 AGENTS.md代理会自动读取离正在编辑的文件最近的那一份。大规模案例也有OpenAI 主仓库当时就有 88 份这样的文件。规则冲突时谁说了算两份文件规则打架时离被编辑文件最近的那份生效你在对话里给的实时指令优先级最高覆盖文件内容。所以全局写通用约束、敏感目录写严格规则这种分层是安全的。能写什么、不能写什么测试命令列进去代理会替你跑文件里列出测试命令后代理会在收尾前尝试运行相关检查并修复失败项。因此只写你愿意让它自动执行的命令危险的命令要显式标注禁止。本仓库自己的 AGENTS.md 就是例子它明确告诉代理只用 dev server、不要跑生产构建。敏感信息别写进配置 ⚠️这份配置会跟着仓库的可见范围走里面的 API key、内网地址、账号凭据等于直接公开。约束和规则写进去密钥留给环境变量或私有配置。全团队共用把配置放进版本管理当作活文档来维护AGENTS.md 随时可以更新。命令变了、架构重构了就同步改配置放进版本管理像评审其他文档一样在 PR 里过一眼。今晚挑一个你迭代最频繁的项目把第一版 AGENTS.md 提交进仓库队友克隆下来就能直接继承。【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考