← 文件教學

快速開始

幾分鐘內跑通第一次程式碼評審

前置條件

Step 1 — 安裝 CLI

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

Step 2 — 配置 LLM

ocr config provider

互動式 TUI 引導你：選擇內建或自訂 provider → 填入 API key → 挑選 model → 自動存檔並跑 ocr llm test 驗證端點。之後換模型：

ocr config model

備選：非互動命令

在 CI 或無 TUI 的環境裡，用 ocr config set 直接寫入同一份配置：

ocr config set provider                    anthropic
ocr config set model                       claude-opus-4-6
ocr config set providers.anthropic.api_key sk-ant-xxxxxxxxxx

Step 3 — 測試連通性

ocr llm test

若報 no valid LLM endpoint configured，重查 Step 2 的配置。401/403 表示 token 錯誤或過期。

Step 4 — 第一次評審

cd path/to/your-repo

# 工作區模式 —— 評審 staged + unstaged + untracked 變更（預設）
ocr review

# 分支區間 —— 評審 feature-branch 自與 main 分叉以來的變更
ocr review --from main --to feature-branch

# 單一 commit
ocr review --commit abc123

想先看看會評審什麼？

ocr review --preview              # 工作區
ocr review -c abc123 --preview    # commit

--preview 跑過濾管線但跳過 LLM，印出檔案清單與排除原因——不花 token。

面向系統的 JSON 輸出

ocr review --format json --audience agent > review.json

--audience agent 屏蔽人性化進度 UI，讓 stdout 只剩 JSON / 最終摘要——正是上游 agent 或 CI 腳本所需。

📖 教學解說：快速開始深入

第一次評審的完整流程

從零開始的完整流程：

  1. npm install -g @alibaba-group/open-code-review → 安裝 CLI
  2. ocr config provider → 互動式選 provider + 填 API key
  3. ocr llm test → 確認連通性
  4. ocr review --preview → 先看會審什麼（不花 token）
  5. ocr review → 真正跑評審

第 ④ 步是新手最容易跳過的——--preview 是你的安全網。

--audience agent 在 CI 中的必要性

CI 腳本中必須傳 --audience agent——它屏蔽進度列 UI，讓 stdout 只剩 JSON / 最終摘要。不傳的話 stdout 混雜 ANSI 轉義碼，JSON 解析會失敗。

三種評審模式的選擇

不要糾結——模式由你手上的變更決定：

  • 有 staged/unstaged 變更 → ocr review（工作區模式）
  • 要審某個 commit → ocr review -c <sha>
  • 要比較兩個 ref → ocr review --from main --to feature

練習 / 驗收清單

  • 能完成從安裝到第一次評審的完整流程
  • 能使用 --preview 安全地預覽
  • 能解釋 --audience agent 在 CI 中的必要性
看完這頁你應該能說出：怎麼在一分鐘內把 OCR 跑起來、三種評審模式的差別、--audience agent 與 --format json 各控制什麼（前者控 UI、後者控結構）。

延伸閱讀：CLI 參考 · 設定 · 評審規則 · FAQ