CLAUDE.md 是決定 Claude 如何理解你專案的唯一檔案。寫得好意味著更少的修正、更好的程式碼,以及真正瞭解工作內容的代理。
本指南將帶你瞭解 CLAUDE.md 檔案的每個部分,從技術棧宣告到代理特定提示。跟著步驟一步步建置你自己的檔案。
CLAUDE.md 是放在專案根目錄的 Markdown 檔案。當 Claude Code 啟動會話時,它會首先讀取這個檔案。檔案中的所有內容都會成為 Claude 的上下文:技術棧、檔案結構、團隊規範,以及你希望每個代理遵循的具體指令。
可以把它看作簡報文件。沒有它,Claude 只能猜測專案的組織方式。有了好的 CLAUDE.md,Claude 已經知道檔案在哪裡、該遵循什麼模式、該避免什麼。輸出品質的差異是顯著的。
“在 CLAUDE.md 上投入 10 分鐘,可以省去數小時修正不符合專案模式的 AI 生成程式碼的時間。”
來自數百個 Claude Code 專案的觀察
CLAUDE.md 的結構和具體程度直接影響 Claude 在程式碼庫中的表現。
結構良好的 CLAUDE.md 涵蓋這六個方面。每個部分都為 Claude 提供可立即使用的具體資訊。
明確列出你的框架、庫及其版本。包括包管理器、Node 版本和任何執行時要求。Claude 使用這些資訊生成相容的程式碼,無需猜測。
描述你的關鍵目錄以及每個目錄中存放的內容。元件、狀態管理、服務、API 路由、型別定義。每個資料夾附帶一行說明的簡短樹狀圖效果很好。
記錄你的命名模式(檔案用 camelCase,元件用 PascalCase)、錯誤處理方式、import 排序和專案特定規則。這確保 Claude 的輸出與現有程式碼保持一致。
包含你的 dev、build、test 和 lint 命令。當 Claude 需要驗證某些功能或建議腳本時,它會使用你專案期望的確切命令。
如果你使用多個代理(QA、前端、後端、DevOps),新增一個描述每個角色應關注什麼的部分。這在 AgentsRoom 的多代理設定中特別有用。
告訴 Claude 不要做什麼。不要修改配置檔案,不要更改認證系統,不要重構資料庫層。明確的邊界防止代理做出不必要的改動。
不需要一次寫完所有內容。從基礎開始,在發現 Claude 需要了解的資訊時逐步擴充套件。
開啟 package.json,列出專案使用的所有框架、庫和工具。記錄版本號,檢查執行時要求(Node 版本、Python 版本、資料庫)。這將成為你的技術棧部分。
package.json + 執行時版本 + 資料庫
快速輸出 src 目錄的樹狀結構。識別頂層資料夾,為每個資料夾寫一行說明。重點關注元件、狀態管理、服務、型別定義和 API 路由的位置。
帶用途註釋的 src/ 樹狀圖
檢視現有程式碼,記錄其中的模式:檔案命名方式、錯誤處理方式、import 的組織方式、使用預設匯出還是命名匯出。將這些寫成簡短的規則。
命名、import、錯誤處理、匯出
如果你使用專業代理,為每個角色新增關注領域。前端代理應瞭解你的元件庫,DevOps 代理應瞭解你的部署流程,QA 代理應瞭解你的測試框架。
按角色劃分的關注領域 + 禁止區域
AgentsRoom 將 CLAUDE.md 作為核心概念建置,而非附加功能。
在 AgentsRoom 內直接編輯 CLAUDE.md,支援語法高亮和實時儲存。無需切換到文字編輯器或 IDE。
實時檢視每個代理如何解讀你的 CLAUDE.md。透過觀察終端輸出,驗證代理是否遵循你的規範並尊重禁止區域。
AgentsRoom 中的每個專案都有自己的 CLAUDE.md。切換專案時,每個代理自動載入該程式碼庫對應的上下文檔案。
AgentsRoom 的 14 個代理角色與 CLAUDE.md 的部分直接對應。按角色定義關注領域和禁止區域,每個代理只獲取針對自己的指令。
CLAUDE.md is prepended to every Claude turn. A bloated CLAUDE.md silently inflates Claude Code token usage on every message. AgentsRoom puts a per-session token meter on each agent so you can see exactly how much your CLAUDE.md is costing you, with a live cache hit rate to confirm it stays cached.
See the Claude Code token usage tracker下載 AgentsRoom,使用內建 CLAUDE.md 編輯器為你的代理提供所需的上下文。好的指令帶來好的程式碼。
配套應用:隨時隨地監控你的 Agent
使用 Claude、Codex、Antigravity CLI 或其他 AI 提供商。
把 Bug 和需求直接傳送到您的公開待辦清單。
AgentsRoom 實際執行一瞥。