Documentation Index
Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Code Review 處於研究預覽階段,適用於 Team 和 Enterprise 訂閱。對於啟用了 Zero Data Retention 的組織,此功能不可用。
CLAUDE.md 或 REVIEW.md 文件來調整 Claude 標記的內容。
要在您自己的 CI 基礎設施中運行 Claude 而不是此託管服務,請參閱 GitHub Actions 或 GitLab CI/CD。對於自託管 GitHub 實例上的存儲庫,請參閱 GitHub Enterprise Server。
本頁涵蓋:
- 審查如何運作
- 設定
- 手動觸發審查,使用
@claude review和@claude review once - 自訂審查,使用
CLAUDE.md和REVIEW.md - 定價
- 故障排除失敗的運行和缺失的評論
審查如何運作
一旦管理員為您的組織啟用 Code Review,審查將在 PR 開啟時、每次推送時或手動請求時觸發,具體取決於存儲庫的配置行為。在任何模式下,評論@claude review 在 PR 上啟動審查。
當審查運行時,多個代理在 Anthropic 基礎設施上並行分析差異和周圍程式碼。每個代理尋找不同類別的問題,然後驗證步驟檢查候選項目是否符合實際程式碼行為,以過濾掉誤報。結果被去重、按嚴重程度排名,並作為內聯評論發佈在發現問題的特定行上,並在審查正文中提供摘要。如果未發現問題,Claude 會在 PR 上發佈簡短的確認評論。
審查成本隨著 PR 大小和複雜性而擴展,平均在 20 分鐘內完成。管理員可以通過 分析儀表板 監控審查活動和支出。
嚴重程度級別
每個發現都標記有嚴重程度級別:| 標記 | 嚴重程度 | 含義 |
|---|---|---|
| 🔴 | 重要 | 應在合併前修復的錯誤 |
| 🟡 | 細節 | 輕微問題,值得修復但不阻止 |
| 🟣 | 預先存在 | 程式碼庫中存在但未由此 PR 引入的錯誤 |
對發現進行評分和回覆
每個來自 Claude 的審查評論都已附加 👍 和 👎,因此兩個按鈕都會在 GitHub UI 中出現,以便一鍵評分。如果發現有用,請點擊 👍;如果發現錯誤或嘈雜,請點擊 👎。Anthropic 在 PR 合併後收集反應計數,並使用它們來調整審查者。反應不會觸發重新審查或更改 PR 上的任何內容。 回覆內聯評論不會提示 Claude 回應或更新 PR。要對發現採取行動,請修復程式碼並推送。如果 PR 訂閱了推送觸發的審查,下一次運行將在問題修復時解決線程。要在不推送的情況下請求新審查,請作為 頂級 PR 評論 評論@claude review once。
檢查運行輸出
除了內聯審查評論外,每次審查都會填充 Claude Code Review 檢查運行,該運行與您的 CI 檢查一起出現。展開其 Details 連結以在一個地方查看每個發現的摘要,按嚴重程度排序:| 嚴重程度 | 文件:行 | 問題 |
|---|---|---|
| 🔴 重要 | src/auth/session.ts:142 | 令牌刷新與登出競爭,留下過時的會話活躍 |
| 🟡 細節 | src/auth/session.ts:88 | parseExpiry 在格式錯誤的輸入上無聲地返回 0 |
gh 和 jq 解析:
{"normal": 2, "nit": 1, "pre_existing": 0}。normal 鍵保存重要發現的計數;非零值意味著 Claude 發現至少一個值得在合併前修復的錯誤。
Code Review 檢查的內容
默認情況下,Code Review 專注於正確性:會破壞生產的錯誤,而不是格式設置偏好或缺失的測試覆蓋。您可以通過 添加指導文件 到您的存儲庫來擴展它檢查的內容。設定 Code Review
管理員為組織啟用 Code Review 一次,並選擇要包含的存儲庫。開啟 Claude Code 管理員設定
前往 claude.ai/admin-settings/claude-code 並找到 Code Review 部分。您需要對 Claude 組織的管理員存取權限以及在 GitHub 組織中安裝 GitHub Apps 的權限。
安裝 Claude GitHub App
按照提示將 Claude GitHub App 安裝到您的 GitHub 組織。該應用請求這些存儲庫權限:
- Contents:讀取和寫入
- Issues:讀取和寫入
- Pull requests:讀取和寫入
設定每個存儲庫的審查觸發器
設定完成後,Code Review 部分在表格中顯示您的存儲庫。對於每個存儲庫,使用 Review Behavior 下拉菜單選擇何時運行審查:
- Once after PR creation:當 PR 開啟或標記為準備審查時,審查運行一次
- After every push:在每次推送到 PR 分支時運行審查,在 PR 演變時捕捉新問題,並在您修復標記的問題時自動解決線程
- Manual:審查僅在有人 在 PR 上評論
@claude review或@claude review once時開始;@claude review也會訂閱 PR 以進行後續推送的審查
@claude review 以開始第一次審查。如果沒有檢查運行出現,請確認存儲庫列在您的管理員設定中,並且 Claude GitHub App 有權存取它。
手動觸發審查
兩個評論命令按需啟動審查。無論存儲庫的配置觸發器如何,兩者都有效,因此您可以使用它們在手動模式下選擇特定 PR 進行審查,或在其他模式下獲得立即重新審查。| 命令 | 它做什麼 |
|---|---|
@claude review | 啟動審查並訂閱 PR 以進行今後的推送觸發審查 |
@claude review once | 啟動單次審查,不訂閱未來推送 |
@claude review once。這對於具有頻繁推送的長期運行 PR 很有用,或者當您想要一次性第二意見而不改變 PR 的審查行為時。
對於任一命令觸發審查:
- 將其發佈為頂級 PR 評論,而不是差異行上的內聯評論
- 在評論開始時放置命令,如果您使用一次性形式,將
once放在同一行 - 您必須對存儲庫具有所有者、成員或協作者存取權限
- PR 必須開啟
自訂審查
Code Review 從您的存儲庫讀取兩個文件來指導它標記的內容。它們在強度上有所不同:CLAUDE.md:Claude Code 用於所有任務的共享項目指令,不僅僅是審查。Code Review 將其讀取為項目背景,並將新引入的違規標記為細節。REVIEW.md:僅審查指導,直接注入到審查管道中每個代理的系統提示中作為最高優先級。使用它來改變標記的內容、嚴重程度以及發現的報告方式。
CLAUDE.md
Code Review 讀取您存儲庫的CLAUDE.md 文件,並將新引入的違規視為 細節級別 的發現。這是雙向工作的:如果您的 PR 以使 CLAUDE.md 陳述過時的方式更改程式碼,Claude 會標記文件需要更新。
Claude 在目錄層次結構的每個級別讀取 CLAUDE.md 文件,因此子目錄的 CLAUDE.md 中的規則僅適用於該路徑下的文件。有關 CLAUDE.md 如何運作的更多信息,請參閱 memory 文檔。
對於您不想應用於一般 Claude Code 會話的審查特定指導,請改用 REVIEW.md。
REVIEW.md
REVIEW.md 是位於您存儲庫根目錄的文件,它覆蓋 Code Review 在您的存儲庫上的行為方式。其內容被注入到審查管道中每個代理的系統提示中作為最高優先級指令塊,優先於默認審查指導。
因為它是逐字粘貼的,REVIEW.md 是純指令:@ 導入語法 不會展開,引用的文件不會讀入提示中。將您想要強制執行的規則直接放在文件中。
您可以調整什麼
REVIEW.md 是自由格式的 markdown,因此任何您可以表達為審查指令的內容都在範圍內。下面的模式在實踐中影響最大。
嚴重程度:重新定義 🔴 重要對您的存儲庫意味著什麼。默認校準針對生產程式碼;文檔存儲庫、配置存儲庫或原型可能想要更窄的定義。明確說明哪些類別的發現是重要的,哪些最多是細節。您也可以向另一個方向升級,例如將任何 CLAUDE.md 違規視為重要而不是默認細節。
細節量:限制單次審查發佈的 🟡 細節評論數量。散文和配置文件可以永遠被打磨。像「最多報告五個細節,在摘要中提及其餘的計數」這樣的上限使審查可操作。
跳過規則:列出 Claude 應該不發佈任何發現的路徑、分支模式和發現類別。常見候選是生成的程式碼、lockfiles、供應商依賴和機器編寫的分支,以及您的 CI 已經強制執行的任何內容,如 linting 或拼寫檢查。對於值得進行某些審查但不完全審查的路徑,設定更高的標準而不是完全跳過:「在 scripts/ 中,僅在接近確定且嚴重時報告。」
存儲庫特定檢查:添加您想在每個 PR 上標記的規則,例如「新 API 路由必須有集成測試。」因為 REVIEW.md 被注入為最高優先級,這些比長 CLAUDE.md 中的相同規則更可靠地著陸。
驗證標準:在發佈發現類別之前需要證據。例如,「行為聲明需要源中的 file:line 引用,而不是從命名推斷」減少了否則會花費作者往返的誤報。
重新審查收斂:告訴 Claude 當 PR 已經被審查時如何表現。像「在第一次審查後,抑制新細節並僅發佈重要發現」這樣的規則阻止一行修復從僅風格達到第七輪。
摘要形狀:要求審查正文以一行計數開頭,例如 2 factual, 4 style,並在這種情況下以「沒有事實問題」開頭。作者想在詳細信息之前知道工作的形狀。
示例
此REVIEW.md 為後端服務重新校準嚴重程度,限制細節,跳過生成的文件,並添加存儲庫特定檢查。
保持專注
長度有成本:長REVIEW.md 會稀釋最重要的規則。將其保留為改變審查行為的指令,並將一般項目背景留在 CLAUDE.md 中。
查看使用情況
前往 claude.ai/analytics/code-review 查看整個組織的 Code Review 活動。儀表板顯示:| 部分 | 它顯示什麼 |
|---|---|
| PRs reviewed | 在選定時間範圍內審查的 pull request 的每日計數 |
| Cost weekly | Code Review 的每週支出 |
| Feedback | 因開發人員解決問題而自動解決的審查評論計數 |
| Repository breakdown | 每個存儲庫審查的 PR 計數和解決的評論 |
定價
Code Review 根據令牌使用情況計費。每次審查平均花費 $15-25,隨著 PR 大小、程式碼庫複雜性和需要驗證的問題數量而擴展。Code Review 使用通過 extra usage 單獨計費,不計入您計劃的包含使用情況。 您選擇的審查觸發器影響總成本:- Once after PR creation:每個 PR 運行一次
- After every push:在每次推送時運行,將成本乘以推送次數
- Manual:在有人在 PR 上評論
@claude review之前沒有審查
@claude review 選擇 PR 進入推送觸發的審查,因此在該評論之後每次推送都會產生額外成本。要運行單次審查而不訂閱未來推送,請改為評論 @claude review once。
成本出現在您的 Anthropic 帳單上,無論您的組織是否為其他 Claude Code 功能使用 Amazon Bedrock 或 Google Vertex AI。要為 Code Review 設定月度支出上限,請前往 claude.ai/admin-settings/usage 並為 Claude Code Review 服務配置限制。
通過 analytics 中的每週成本圖表或管理員設定中的每個存儲庫平均成本列監控支出。
故障排除
審查運行是盡力而為的。失敗的運行永遠不會阻止您的 PR,但它也不會自動重試。本部分涵蓋如何從失敗的運行中恢復,以及在檢查運行報告您找不到的問題時在哪裡查看。重新觸發失敗或超時的審查
當審查基礎設施遇到內部錯誤或超過其時間限制時,檢查運行完成,標題為 Code review encountered an error 或 Code review timed out。結論仍然是中立的,因此沒有任何東西阻止您的合併,但沒有發現被發佈。 要再次運行審查,在 PR 上評論@claude review once。這啟動一個新的審查,不訂閱 PR 以進行未來推送。如果 PR 已訂閱推送觸發的審查,推送新提交也會啟動新審查。
GitHub 的 Checks 標籤中的 Re-run 按鈕不會重新觸發 Code Review。改用評論命令或新推送。
審查未運行,PR 顯示支出上限消息
當您的組織的月度支出上限達到時,Code Review 在 PR 上發佈單個評論,解釋審查被跳過。審查在下一個計費期開始時自動恢復,或當管理員在 claude.ai/admin-settings/usage 提高上限時立即恢復。查找未顯示為內聯評論的問題
如果檢查運行標題說發現了問題,但您在差異上看不到內聯審查評論,請在這些其他位置查看發現的位置:- Check run Details:在 Checks 標籤中的 Claude Code Review 檢查旁邊點擊 Details。嚴重程度表列出每個發現及其文件、行和摘要,無論內聯評論是否被接受。
- Files changed annotations:在 PR 上打開 Files changed 標籤。發現呈現為直接附加到差異行的註釋,與審查評論分開。
- Review body:如果您在審查運行時推送到 PR,某些發現可能引用當前差異中不再存在的行。這些出現在審查正文文本中的 Additional findings 標題下,而不是作為內聯評論。
相關資源
Code Review 設計用於與 Claude Code 的其餘部分一起工作。如果您想在開啟 PR 之前在本地運行審查、需要自託管設定,或想深入了解CLAUDE.md 如何在工具中塑造 Claude 的行為,這些頁面是很好的下一步:
- Plugins:瀏覽插件市場,包括用於在推送前本地運行按需審查的
code-review插件 - GitHub Actions:在您自己的 GitHub Actions 工作流中運行 Claude,以實現超越程式碼審查的自訂自動化
- GitLab CI/CD:GitLab 管道的自託管 Claude 集成
- Memory:
CLAUDE.md文件如何在 Claude Code 中工作 - Analytics:追蹤超越程式碼審查的 Claude Code 使用情況