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
需要開通或續費?AI 會員充值與全部商品 →

Nathaniel 的更多內容

  1. 01

    AI 學習路線:零基礎從哪開始,6 個階段、每階段該讀哪幾篇教學(2026)

    AI 學習路線怎麼走?給零基礎的人一條循序漸進的路徑:先選一個助手用順,再學提問,再用進日常工作,按需學做圖做影片,守住私隱與版權,最後進階自動化和編程。每個階段都配了本站對應的教學。

    其他 AI 工具0
  2. 02

    AI 瀏覽器有哪些:Perplexity Comet、Opera Neon、Dia、Brave Leo 與 Edge Copilot 的官方說法對照

    AI 瀏覽器有哪些?按官方頁面整理 Perplexity Comet、Opera Neon、Dia、Brave Leo 和 Edge 裏的 Copilot:官方自述的定位、支持的平台、免費還是訂閱,以及 Gemini、Claude 的 Chrome 方案和已停用的 ChatGPT Atlas。

    其他 AI 工具0
  3. 03

    即夢國際版 Dreamina 是什麼:官方站入口、能生成什麼、免費積分和模型(2026)

    即夢國際版 Dreamina 是什麼?官方站是 dreamina.capcut.com,是一個圖片、影片和數字人一體的 AI 創作平台。按官方首頁和 FAQ 講:能生成什麼、免費用戶每天 120 積分、列出的 Seedance 與 Seedream 模型,以及和國內即夢怎麼區分。

    其他 AI 工具0
  4. 04

    Kimi K3 Coding Plan 是什麼、怎麼用:Kimi Code 會員、模型 ID、套餐價格和額度規則

    Kimi K3 Coding Plan 是什麼?按 Kimi 官方文檔核對:官方現在叫 Kimi Code,是 Kimi 會員權益裏的編程服務,Plus 及以上才有;講 K3 等模型 ID、國內新套餐價格、三種客戶端、第三方工具接入和額度規則。

    Kimi0
  5. 05

    DeepSeek V4 Pro 和 Flash 的區別與 API 價格:官方價格頁逐項對照(高峰與空閒時段)

    DeepSeek V4 Pro 和 Flash 有什麼區別、API 怎麼收費?按 DeepSeek 官方價格頁(2026-10-19 查詢)列出兩個模型的版本、上下文、圖像理解、並發和每百萬 token 價格,說明高峰與空閒時段的計費差別和舊模型名怎麼處理。

    其他 AI 工具0
  6. 06

    GPT-6 Pro(Astra)怎麼用、哪些套餐有:怎麼選到 Pro 檔、用量限制和 Pro 三檔價格

    GPT-6 Pro(Astra)怎麼用、哪些套餐有?按 OpenAI 幫助中心核對:聊天裏 Pro 檔給 Pro 100、Pro 200、Business 和 Enterprise;Plus 在 Work 和 Codex 裏含 Astra。講怎麼選到、用量上限和官方 Pro 價格。

    ChatGPT0

同產品的其他教學

  1. 01

    AI圖片放大與高清修復:Midjourney、ChatGPT、Gemini 怎麼出高解像度圖

    AI 生成的圖不夠清晰,想打印或做大圖怎麼辦?本文按官方文檔講清 Midjourney 的 Subtle / Creative 放大和 HD 直出、Gemini 與 ChatGPT 的解像度選項、Flow 的影片放大,以及「AI 放大會編造細節」的注意事項。

    Gemini其他 AI 工具0
  2. 02

    AI影片運鏡提示詞大全:推拉搖移跟升降、環繞、甩鏡怎麼寫(中英對照)

    AI 影片的運鏡提示詞怎麼寫?本文按 Google 官方影片提示指南整理鏡頭運動、機位角度、鏡頭光學效果三張中英對照表,每個術語配效果說明和例句,並給出組合運鏡的寫法和常見翻車原因,適用於 Veo、即夢、可靈等工具。

    Gemini其他 AI 工具0
  3. 03

    AI 影片翻譯怎麼做:用 ElevenLabs 給影片自動配音翻譯、轉寫並生成字幕

    想把一段影片翻譯成另一種語言並保留原聲音色?本文按 ElevenLabs 官方文檔講清 Dubbing 自動配音翻譯的操作步驟、文件限制、免費檔水印與計費方式,以及用 Speech to Text 轉寫、在字幕編輯器裏調整並導出字幕的流程。

    其他 AI 工具0
  4. 04

    MCP Inspector 怎麼用:安裝、啟動命令、調試 MCP 伺服器與 v2 的變化

    MCP Inspector 是什麼、怎麼安裝和使用?按 MCP 官方文檔講清網頁、命令行、終端介面三種模式的啟動命令,怎麼連本地和遠程伺服器、怎麼傳環境變量,密鑰存在哪,以及 v2 相比舊教學在端口、令牌變量名和 Node 版本上的變化。

    Claude其他 AI 工具0
  5. 05

    MCP 的 stdio、SSE 和 Streamable HTTP 有什麼區別:本地與遠程 MCP 怎麼選

    MCP 配置裏的 stdio、sse、http 到底差在哪?按 MCP 官方規範講清兩種標準傳輸方式的工作原理、Streamable HTTP 與舊的 HTTP+SSE 的關係、會話與斷線續傳、規範對安全的硬性要求,以及本地伺服器和遠程伺服器各適合什麼場景。

    Claude其他 AI 工具0
  6. 06

    Midjourney 可以商用嗎:作品歸屬、商用條件與隱身模式

    Midjourney 生成的圖片和影片能不能商用、版權歸誰、公司用要什麼套餐、作品會不會被別人看到?本文按 Midjourney 服務條款逐條解釋,並補充中美對 AI 生成圖片版權的官方 / 司法觀點。

    其他 AI 工具0

0 條評論

登入 後參與評論

還沒有評論,來搶沙發~