AGENTS.md 怎么写:规范、模板,以及 Cursor、Copilot、Trae、Kiro、Cline 各自怎么读

AGENTS.md 是什么、怎么写?给一份可改写的中文模板,并按各家官方文档列出 Cursor、GitHub Copilot、Devin Desktop、Trae、Kiro、Cline、Gemini CLI 读取 AGENTS.md 的规则与差异,讲清一个仓库多种工具时怎么只维护一份。

NNathaniel bigo··原创首发·AI 辅助撰写
9 分钟读完
资料核对于 2026-10-11 · 依据官方文档与公开资料整理 免费账号 账号
本文根据 AGENTS.md 官网和 Cursor、GitHub Copilot、Devin Desktop、TRAE、Kiro、Cline 各自的官方文档整理,资料核对于 2026-10-11。Claude Code 的 CLAUDE.md 与 Codex 的读取细节,见本站《CLAUDE.md 怎么写》,本文侧重「一份文件给多种工具用」。

适用于谁

  • 团队里有人用 Cursor、有人用 Copilot、有人用 Trae,不想每种工具维护一份规则的人;
  • 搜「agents.md 怎么写」「agents.md 模板」「agents.md 规范」「agents.md 最佳实践」的人;
  • 已经有 .cursorrules、copilot-instructions.md,想知道要不要迁到 AGENTS.md 的人。

结论先说

  1. AGENTS.md 是给编程智能体看的 README:一个放在仓库里的普通 Markdown 文件,写构建步骤、测试命令和代码约定。没有必填字段,标题随意。
  2. 它是开放格式,官网称已有 6 万多个开源项目使用,现由 Linux 基金会下的 Agentic AI Foundation 管理。
  3. 通用规则:放在仓库根目录;大仓库可以在子目录里再放,离被编辑文件最近的那份优先;你在对话里的明确指示高于一切。
  4. 主流工具大多自动读取,但有例外:Trae 要手动打开开关,Gemini CLI 和 Aider 要改配置。
  5. 推荐做法:通用约定只写在 AGENTS.md 里,各工具专属的规则文件只放该工具独有的内容。

各工具怎么读 AGENTS.md

工具是否自动读取读哪些位置官方说明的要点
Cursor是项目根目录和子目录作为 .cursor/rules 的简单替代;子目录的指令与上级合并,越具体越优先
GitHub Copilot是仓库内任意位置,可多份目录树里最近的一份优先;根目录下单独一份 CLAUDE.md 或 GEMINI.md 也可作为智能体指令
Devin Desktop(原 Windsurf)是工作区任意目录与规则共用同一套引擎:根目录的始终生效,子目录的只对该目录生效
Kiro是工作区根目录、子目录、~/.kiro/steering/不支持加载方式设置,始终加载
Cline是AGENTS.md、~/.agents/AGENTS.md与 .cursorrules、.windsurfrules 一样自动识别,可在 Rules 面板里单独开关
Trae否,需打开开关项目根目录;子目录模块下的也可设置 > 规则与记忆 > 导入设置里打开「将 AGENTS.md 包含在上下文中」
Gemini CLI需配置—在 .gemini/settings.json 里设置 {"context": {"fileName": "AGENTS.md"}}
Aider需配置—在 .aider.conf.yml 里写 read: AGENTS.md
Claude Code / Codex见另一篇—《CLAUDE.md 怎么写》

写什么

官网列出的常见小节:项目概览、构建和测试命令、代码风格、测试说明、安全注意事项;再加上提交信息和 PR 规范、安全上的坑、部署步骤——任何你会告诉新同事的东西。

一份可以直接改写的中文模板:

markdown
# AGENTS.md

## 项目概览
Next.js 14 + TypeScript 的电商后台;数据库 Prisma + MySQL;包管理用 pnpm。

## 常用命令
- 安装依赖:`pnpm install`
- 本地启动:`pnpm dev`
- 类型检查:`pnpm typecheck`
- 单元测试:`pnpm test`;只跑一个用例:`pnpm vitest run -t "用例名"`

## 代码约定
- TypeScript 严格模式;组件用具名导出
- 金额一律用「分」为单位的整数
- 新接口先写入参校验,再写业务逻辑

## 测试要求
- 改了代码就要补或改对应的测试,即使没人要求
- 提交前类型检查和测试必须全部通过

## 不要碰
- `src/generated/`、`prisma/migrations/` 下的已有文件
- 任何 `.env*` 文件;需要新的环境变量时告诉我,不要自己写

## 提交与 PR
- 提交信息用中文,格式「类型: 简述」
- 一个 PR 只做一件事

官网 FAQ 里有一条值得知道:写在 AGENTS.md 里的测试命令,智能体会自动去跑——它会尝试执行相关检查,并在结束任务前修复失败项。所以命令要写准确、可直接执行。

写多长、怎么分

  • 只写会被反复用到的。几家官方的建议是一致的:Cursor 说规则应聚焦、可执行,不要照抄整份代码规范(交给 linter);GitHub 给 cloud agent 生成指令的提示词把篇幅限制在两页以内。
  • 大仓库用嵌套。在每个子包里放一份 AGENTS.md,智能体读最近的那份。官网举例说 OpenAI 的主仓库里有 88 个 AGENTS.md。
  • 当作活文档。智能体反复犯同一个错,就把纠正写进去。
text
project/
  AGENTS.md              # 全局约定
  frontend/
    AGENTS.md            # 前端专属
  backend/
    AGENTS.md            # 后端专属

一个仓库多种工具:只维护一份

第一层:AGENTS.md 放通用内容。命令、目录、约定、禁区——换任何工具都成立的东西。

第二层:各工具的专属文件只放专属内容。

工具专属文件适合放什么
Cursor.cursor/rules/*.mdc需要按 glob 生效或手动 @ 的规则(AGENTS.md 做不到)
GitHub Copilot.github/copilot-instructions.md、.github/instructions/*.instructions.md代码审查的关注点、按路径生效的规则
Kiro.kiro/steering/*.md需要 fileMatch / manual / auto 加载方式的规则
Trae.trae/rules/*.md按文件或场景生效的规则、提交信息规则
Claude CodeCLAUDE.md第一行写 @AGENTS.md 导入,下面只补 Claude 专属内容

GitHub 官方文档对这种分工有一句很好的概括:copilot-instructions.md 是「Copilot,在这个仓库里始终记住这些」,AGENTS.md 是「任何智能体都记住这些」。

从旧文件迁移:官网给的做法是改名并留一个符号链接保持兼容,例如:

bash
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md

Cline 会自动识别 .cursorrules 和 .windsurfrules,Devin Desktop 仍读取旧的 .windsurfrules,所以迁移可以慢慢来,不必一次改完。

常见问题

Q:指令冲突时听谁的?

离被编辑文件最近的 AGENTS.md 优先;你在对话里明确说的话高于文件。工具自己的规则文件和 AGENTS.md 之间的优先级各家不同(例如 Cursor 是团队规则 → 项目规则 → 用户规则依次合并),所以最好的办法是不要让它们写同一件事。

Q:AGENTS.md 里能放密钥、内部地址吗?

不要。它会随仓库提交,也会被原样送进模型上下文。需要的凭据放环境变量,文件里只写变量名。

Q:别人仓库里的 AGENTS.md 可以直接信吗?

要先看一眼。它就是会被智能体执行的指令,来历不明的仓库里可能写着让智能体执行危险命令的内容。Kiro 的文档在讲多仓库任务时专门提醒:只选你信任的仓库,因为智能体会遵循仓库里的指示。更多见《AI 编程安全注意事项》。

Q:有没有现成的规则和技能可以参考?

本站的 Skill 库 收录了一批公开的技能与规则仓库,可以按语言和用途挑着看,再改成适合自己项目的版本。

参考资料

  • AGENTS.md 官网:https://agents.md/
  • Rules(Cursor 官方):https://cursor.com/docs/rules
  • Adding repository custom instructions for GitHub Copilot(GitHub 官方):https://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions
  • Memories & Rules(Devin Desktop 官方):https://docs.devin.ai/desktop/cascade/memories
  • 规则(Rule)(TRAE 官方):https://docs.trae.ai/ide/rules
  • Steering(Kiro 官方):https://kiro.dev/docs/steering
  • Rules(Cline 官方):https://docs.cline.bot/customization/cline-rules

Nathaniel 的更多内容

  1. 01

    promptfoo 使用教程:对比提示词和模型、写断言自动评测(安装与配置)

    promptfoo 是什么、怎么使用?按官方 README 和入门文档讲清它的用途、三种安装方式、用示例项目起步、promptfooconfig.yaml 里提示词、模型和测试用例三部分怎么写、常用断言类型的含义、eval 与 view 两条命令,以及把它放进日常改提示词流程的方法。

    ChatGPT其他 AI 工具0
  2. 02

    Kimi API怎么用:API Key获取、Python调用、K3价格与429报错处理

    Kimi API Key 在哪里获取、怎么用 Python 调用 K3、价格怎么算、429 和 401 报错怎么办?本文按 Kimi API 开放平台官方文档讲清注册认证、创建 Key、base_url 与模型名、计费规则和常见错误排查。

    Kimi0
  3. 03

    Cursor Agent 模式怎么用:Agent、Plan、Ask 三种模式,检查点回滚与消息排队

    Cursor Agent 模式是什么、和 Plan / Ask 模式怎么选?按官方文档讲清 Agent 能调用哪些工具、Shift+Tab 切换模式、Plan 模式先出方案再动手、用检查点撤销改动、任务进行中排队或插话,以及 /goal 长目标。

    Cursor0
  4. 04

    Gemini 聊天记录怎么导出:导出到文档 / 表格、生成 PDF 与用 Takeout 批量导出完整对话

    Gemini 没有「一键导出全部对话」的按钮,但有三条官方路径:单条回答导出到 Google 文档、Gmail、表格;让 Gemini 直接生成 PDF、Word、Markdown 文件;用 Google Takeout 批量下载全部活动记录。本文给出每种方法的步骤和限制。

    Gemini0
  5. 05

    ChatGPT 生成图片中文乱码、文字错误怎么办:7 个按顺序试的办法

    让 ChatGPT 做海报、封面、信息图,中文总是缺笔画、错字、乱码?本文按 OpenAI 官方图像提示指南,给出从写法、字数、局部修改、质量档位到后期排版的 7 个办法,以及什么时候干脆别让 AI 写字。

    ChatGPT0
  6. 06

    OpenCode Skills 使用指南:技能目录、命名规则、权限配置与不加载排查

    OpenCode 的 Skills 放在哪个目录、怎么控制哪些技能能用?按 OpenCode 官方文档讲清六个扫描位置、name 的正则规则、skill 工具的工作方式、在 opencode.json 里用 allow / deny / ask 配置权限、按智能体覆盖,以及技能不出现时的五项检查。

    其他 AI 工具0

同产品的其他教程

  1. 01

    Cursor、Claude Code、Codex、GitHub Copilot 有什么区别:按形态、账号、计费和规则文件对比

    Cursor 和 Claude Code 的区别是什么、和 Codex、GitHub Copilot 怎么选?只用各家官方文档的事实对比:产品形态、用什么账号、怎么计费、能选哪些模型、规则文件与 MCP、权限模式、代码审查;不做「谁更强」的排名,给出按场景选择的思路。

    ClaudeCursor0
  2. 02

    MinerU 是什么、怎么用:把 PDF 等文档解析成 Markdown(4.0 的安装、四档解析与命令)

    MinerU 是什么、怎么安装使用?按官方中文 README 讲清 4.0 版本的定位、支持的输入与输出格式、flash / basic / standard / advanced 四档解析各适合什么、pip 安装命令、mineru-kit 与 mineru 两个命令的分工和常用写法,以及从旧版升级要注意什么。

    其他 AI 工具0
  3. 03

    npx skills add 怎么用:从 GitHub 安装 Skill、skills.sh 是什么与常用命令

    网上的 Skill 安装命令大多是 npx skills add 开头,它是什么、装到哪去了?按官方 README 讲清 skills 命令行工具支持的来源写法、项目与全局两种范围、-a 指定工具、list / find / update / remove 等命令、软链接与复制的区别,以及怎么关掉遥测。

    Claude其他 AI 工具0
  4. 04

    即梦首尾帧怎么用:两张图生成过渡视频(在哪里、提示词、不能用怎么办)

    即梦首尾帧在哪里、怎么用?本文讲清首尾帧入口、哪些模型支持、两张图的比例要求、过渡提示词怎么写,以及「首尾帧不见了 / 不能用了」「画面跳变」的原因和解决办法。

    其他 AI 工具0
  5. 05

    DeepSeek怎么用:网页版与手机App入门(深度思考、智能搜索、上传文件)

    DeepSeek怎么用?本文从官方入口和登录方式讲起,说清输入框里的「深度思考」「智能搜索」和上传附件各管什么,历史对话怎么改名、置顶、分享和导出,以及手机上使用的注意点。

    其他 AI 工具0
  6. 06

    文心一言网页版怎么用:改名「文心」后的入口、对话与工作任务、PPT生成

    文心一言现在叫什么、网页版入口在哪、怎么用?本文按百度文心官网和 App Store 官方页面讲清「文心」的新入口、对话与工作两种模式、图片生成和帮我写作、任务托管与 AIPPT、知识库和定时任务从哪开始。

    其他 AI 工具0

0 条评论

登录 后参与评论

还没有评论,来抢沙发~