安裝指南 · OpenCodeReview 繁中教學站

先記住這件事：OCR 需要 Git ≥ 2.41 與 Node.js ≥ 18（除非你用 release 二進位）。裝完跑 ocr version 確認。若你用委託模式（如 Claude Code / OpenCode 內），就不需要自己配置 LLM API key。

Step 1 — 安裝 CLI（npm，推薦）

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

用 npm 安裝時，ocr 預設會自動保持最新：每次執行靜默檢查 registry，18 分鐘冷卻（OCR_UPDATE_INTERVAL 分鐘調整）。關閉自動更新：OCR_NO_UPDATE=1。

Step 1' — 其他安裝方式

# Homebrew（macOS / Linux）
brew install open-code-review

# MacPorts（macOS）
sudo port install open-code-review

# curl | sh 安裝腳本（CI 基礎鏡像 / 無界面環境）
curl -fsSL https://raw.githubusercontent.com/alibaba/open-code-review/main/install.sh | sh

# Windows（PowerShell 5.1+）
irm https://raw.githubusercontent.com/alibaba/open-code-review/main/install.ps1 | iex

curl/sh 與 PowerShell 腳本支援 OCR_INSTALL_DIR（預設 /usr/local/bin 或 %LOCALAPPDATA%\Programs\ocr）與 OCR_VERSION 環境變數。

Step 2 — 配置 LLM

ocr config provider      # 選擇內建或自訂 provider、填入 API key、挑 model
ocr config model         # 之後換模型
ocr llm test             # 驗證連通性

非互動環境（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-xxx。

不用設也行：若你已配好 Claude Code 的 ANTHROPIC_*，或 OCR 自己的 OCR_LLM_* 環境變數，OCR 會自動識別。完整 provider 表與環境變數見設定。

Step 3 — 第一次評審

cd path/to/your-repo
ocr review                        # 工作區模式：staged + unstaged + untracked
ocr review --from main --to feature-branch
ocr review --commit abc123

GitHub Release 二進位（不想裝 Node.js）

# macOS（Apple Silicon）
curl -Lo ocr https://github.com/alibaba/open-code-review/releases/latest/download/opencodereview-darwin-arm64
chmod +x ocr && sudo mv ocr /usr/local/bin/ocr

# Linux x86_64
curl -Lo ocr https://github.com/alibaba/open-code-review/releases/latest/download/opencodereview-linux-amd64
chmod +x ocr && sudo mv ocr /usr/local/bin/ocr

# Windows（AMD64）
curl -Lo ocr.exe https://github.com/alibaba/open-code-review/releases/latest/download/opencodereview-windows-amd64.exe

每個 release 旁有 sha256sum.txt 供校驗。

從原始碼建置

git clone https://github.com/alibaba/open-code-review.git
cd open-code-review
make build              # 產出 dist/opencodereview
sudo cp dist/opencodereview /usr/local/bin/ocr

make test               # LC_ALL=C go test -v -race -count=1 ./...

需求：Go ≥ 1.25、Git、Make。

Shell 補全（可選）

source <(ocr completion bash)            # bash
ocr completion zsh > "${fpath[1]}/_ocr"   # zsh
ocr completion fish | source              # fish
ocr completion powershell | Out-String | Invoke-Expression   # PowerShell

OCR 在哪裡存放狀態

路徑	內容
`~/.opencodereview/config.json`	LLM 端點、語言、遙測配置（`ocr config set` 管理）
`~/.opencodereview/rule.json`	可選的全域評審規則
`~/.opencodereview/sessions/…`	每次評審的 JSONL 轉錄（供 ocr viewer）
`<repo>/.opencodereview/rule.json`	可選的專案級評審規則——可安全提交

疑難排解

問題	解決方式
`command not found: ocr`	確認安裝位置在 `$PATH`（`which ocr`）
`no valid LLM endpoint configured`	用 `ocr config set` 或環境變數補齊 (URL, token, model) 三元組，再 `ocr llm test`
`not a git repository`	`cd` 進 repo，或 `--repo /path/to/repo`
評審跑在「No tool calls parsed」重試	模型不支援原生工具呼叫——換 qwen3 等有 tools 的模型（見 FAQ）

完整除錯見 FAQ 與快速開始。