AGENTS.md - 一種簡單的開放格式，用於指導編碼代理人

AGENTS.md 是一種簡單的開放格式，旨在指導編碼代理，已被超過 20,000 個開源項目使用。它作為一個專門的空間，提供上下文和指示，幫助 AI 編碼代理有效地進行項目工作。這種格式補充了傳統的 README.md 文件，專注於編碼代理的具體需求。

1. 設置命令

   • 安裝依賴：pnpm install
   • 啟動開發伺服器：pnpm dev
   • 執行測試：pnpm test

2. 代碼風格指南

   • TypeScript 嚴格模式
   • 單引號，不使用分號
   • 偏好函數式編程模式

3. 代理兼容性

   AGENTS.md 與各種 AI 編碼代理無縫協作，包括：

   代理名稱	描述
   Codex	用於 AI 編碼代理的通用 CLI 工具。
   Amp	來自 Google 的 AI 編碼代理。
   Jules	來自 Google 的另一個 AI 編碼代理。
   Cursor	用於提高生產力的 AI 編碼工具。
   Factory	用於構建和管理編碼代理的工具。
   Roo	用於各種編程任務的 AI 編碼助手。
   CodeAider	用於代碼輔助和生成的 AI 工具。
   Gemini CLI	來自 Google 的編碼任務 CLI 工具。
   Kilo Code	用於簡化開發的 AI 編碼代理。
   OpenCode	用於協作項目的開源編碼代理。
   Phoenix	用於提高編碼效率的 AI 工具。
   Zed	用於各種編程語言的 AI 編碼助手。

4. 嵌套 AGENTS.md 文件

   對於大型單體倉庫，可以在子項目中使用嵌套的 AGENTS.md 文件，為每個包提供量身定制的指示。

1. 在您的倉庫根目錄創建一個 AGENTS.md 文件。
2. 包含幫助代理有效工作的部分，例如項目概述、構建命令和測試指示。
3. 添加與新貢獻者相關的任何額外指示，例如提交消息和安全考慮。
4. 對於大型項目，利用嵌套的 AGENTS.md 文件為特定子項目提供本地化指導。

AGENTS.md 中是否有必填字段？

不，AGENTS.md 是靈活的，可以根據需要使用任何標題進行結構化。代理將解析提供的文本。

如果指示衝突會怎樣？

距編輯文件最近的 AGENTS.md 文件具有優先權，而明確的用戶提示將覆蓋任何衝突的指示。

代理會自動運行測試命令嗎？

是的，如果 AGENTS.md 中列出了測試命令，代理將嘗試執行它們並修復任何失敗。

AGENTS.md 可以稍後更新嗎？

當然可以，AGENTS.md 應被視為可以根據需要進行修改的活文檔。

價格數據尚不可用；請訪問官方網站以獲取更多信息。

1. AGENTS.md 有效地為編碼代理提供了一種結構化格式，增強了它們理解項目需求和高效執行任務的能力。
2. 與 README.md 文件的分離有助於保持人類貢獻者的清晰度，同時為 AI 代理提供詳細指導。
3. 然而，採用 AGENTS.md 可能需要在習慣於傳統文檔實踐的團隊中進行文化轉變。
4. 總體而言，AGENTS.md 是一個有價值的工具，適合希望通過 AI 編碼代理簡化工作流程的開發者，但其成功取決於一致的使用和更新。