部落格

Alibaba 的 Open Code Review:安裝與首次審查

Markdown

設定 Open Code Review 使用的模型、檢查 Git 變更,並檢視審查結果。委派模式會使用代理程式自己的模型。

閱讀全文

Ailoot 文件:API、金鑰與整合。

Open Code Review 的功能

重點

Open Code Review(OCR)是一款用來審查程式碼的命令列工具。它會讀取 Git 變更,將檔案傳送給已設定的語言模型,並回傳對應到特定程式碼行的意見。這是額外的一次審查,並不能證明程式碼沒有錯誤。

這個專案以 Apache-2.0 授權條款發布於 Alibaba 的官方儲存庫。開發者在 README 中表示,這項工具會將程式化的檔案選取與規則,結合負責分析程式碼的代理程式。如果沒有具意義的差異(Git 變更集合),也可以使用 ocr scan 檢查整個檔案。

先進行第一次審查,並評估針對你自己的程式碼所提出的意見。本文並未測量你的專案能節省多少 token。關於「已完成」的虛假宣稱的文章說明了為何有必要另外檢查代理程式的結果。

準備儲存庫並安裝 OCR

使用這種安裝方式需要 Git 2.41 或更新版本,以及 npm。先準備一個不含機密資料的測試儲存庫。代理程式可以讀取整個檔案並搜尋程式碼庫;工作目錄模式也會包含未追蹤的檔案。請檢查整個儲存庫,包括新檔案:其中不得包含不能傳送給所選模型的金鑰或資料。

git --version
npm install -g @alibaba-group/open-code-review

安裝後即可使用 ocr 命令。請依據官方 README 確認安裝方式和套件本身,不要使用名稱相似的陌生套件。

設定模型並執行審查

在終端機中執行:

ocr config provider
ocr config model

互動式介面會要求你選擇供應商、輸入 API 金鑰並設定模型,接著檢查連線。請在指定的介面中輸入金鑰,不要將它放進專案檔案或提交訊息。在執行審查前,請先了解所選供應商的收費方式:OCR 採用免費授權,不代表模型呼叫也免費。

前往專案目錄並執行審查。請將 your-project 替換成專案的路徑:

cd your-project
ocr review

在此模式中,ocr review 會檢查已暫存、未暫存以及新增的未追蹤變更。若要將意見儲存為 JSON,可以使用:

ocr review --format json --output result.json

不要自動將報告加入提交。請先確認其中不含敏感程式碼或資料。另有命令可檢查目錄中的整個檔案,不論檔案是否有變更:

ocr scan --path internal/agent

internal/agent 是 README 中的範例,請替換成專案中現有的路徑。掃描所有檔案之前,先從小型目錄開始,評估意見的實用性和實際費用。

如何判斷審查是否有幫助

開啟每則意見,找到對應的程式碼行,並確認能否重現問題。透過測試確認修正,並另外記錄誤報。沒有收到任何意見,不能取代功能測試和存取控制檢查。

開發者在 README 的比較結果中指出,OCR 偵測到的問題比例低於通用型代理程式。這是開發者在其研究條件下提出的說法,並非對你專案品質的測量。本文沒有對 OCR 的準確度進行獨立測量。

委派模式有何不同

一般模式會使用 OCR 中設定的模型。委派模式則由 OCR 選取檔案並決定規則,再由你的 AI 代理程式使用自己的模型審查程式碼。在此模式中,不需要為 OCR 另外設定模型或提供 API 金鑰。

README 中的準備命令:

ocr delegate preview
ocr delegate rule src/main.go src/handler.go

請將路徑替換成你自己的路徑。執行這些命令後,還要將分析交給已連線的代理程式:準備檔案並不等於完成程式碼審查。代理程式的收費條件與使用限制仍然適用,因此「不需要額外金鑰」不代表「審查免費」。

儲存庫說明了與 Claude Code、Codex 及其他代理程式的整合方式。如果你使用 Codex,請先熟悉 Codex 技能的運作方式;如果使用其他受支援的工具,則可參閱Kimi Code 入門介紹。先了解一般模式的報告,再連接整合功能,不要用它取代閱讀報告。

執行後沒有結果時

確認已安裝所需版本的 Git、目前位於正確的專案目錄,而且模型連線正常。如果沒有變更可供審查,不要把空白結果稱為整個程式碼庫的審查:檢查整個檔案應使用 scan。不要只根據一份不熟悉的報告就自動阻止提交。

本文所列命令已依據固定版本的儲存庫中的官方 README 核對。本文未在使用者的專案上進行任何付費執行。第一次嘗試成功的判準,是收到清楚的意見,且你能以具體理由確認或駁回這些意見。

如果你需要透過 Ailoot 使用 AI 模型,請看看Ailoot。

更多詳情

常見問題:Alibaba 的 Open Code Review:安裝與首次審查

OCR 沒有留下評論,就代表程式碼正確嗎?

不能。先確認預定 Git 變更真的有被審查,並保留功能及存取控制測試。每個回報都要查看指向行並重現問題,誤報則另行記錄。

委派模式會讓審查免費嗎?

不會。它把分析交給已連接的代理,省去另外設定 OCR 模型,但該代理本身的付款條件與限制仍適用。預覽及規則指令只是準備交接,不是已完成審查。

所有文章