@alibaba-group/open-code-review 1.3.5 → 1.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.ja-JP.md CHANGED
@@ -113,18 +113,22 @@ sudo cp dist/opencodereview /usr/local/bin/ocr
113
113
 
114
114
  **コードレビューの前に必ずLLMを設定する必要があります。**
115
115
 
116
+ **オプションA: 対話的セットアップ(推奨)**
117
+
118
+ ```bash
119
+ ocr config provider # ビルトインプロバイダーを選択またはカスタムプロバイダーを追加
120
+ ocr config model # アクティブなプロバイダーのモデルを選択
121
+ ```
122
+
123
+ ![Provider setup](imgs/providers.jpg)
124
+
125
+ **オプションB: 手動設定**
126
+
116
127
  ```bash
117
- # オプションA: 対話的な設定
118
128
  ocr config set llm.url https://api.anthropic.com/v1/messages
119
129
  ocr config set llm.auth_token your-api-key-here
120
130
  ocr config set llm.model claude-opus-4-6
121
131
  ocr config set llm.use_anthropic true
122
-
123
- # オプションB: 環境変数(最優先)
124
- export OCR_LLM_URL=https://api.anthropic.com/v1/messages
125
- export OCR_LLM_TOKEN=your-api-key-here
126
- export OCR_LLM_MODEL=claude-opus-4-6
127
- export OCR_USE_ANTHROPIC=true
128
132
  ```
129
133
 
130
134
  設定は`~/.opencodereview/config.json`に保存されます。
@@ -133,12 +137,19 @@ export OCR_USE_ANTHROPIC=true
133
137
 
134
138
  ```bash
135
139
  ocr config set llm.auth_header x-api-key
136
- # または
137
- export OCR_LLM_AUTH_HEADER=x-api-key
138
140
  ```
139
141
 
140
142
  サポートされる値:`x-api-key`、`authorization`(エイリアス:`bearer`)。それ以外の値はエラーになります。
141
143
 
144
+ **オプションC: 環境変数(最優先)**
145
+
146
+ ```bash
147
+ export OCR_LLM_URL=https://api.anthropic.com/v1/messages
148
+ export OCR_LLM_TOKEN=your-api-key-here
149
+ export OCR_LLM_MODEL=claude-opus-4-6
150
+ export OCR_USE_ANTHROPIC=true
151
+ ```
152
+
142
153
  また、Claude Codeの環境変数(`ANTHROPIC_BASE_URL`、`ANTHROPIC_AUTH_TOKEN`、`ANTHROPIC_MODEL`)とも互換性があり、`~/.zshrc` / `~/.bashrc`からこれらのexportをパースします。
143
154
 
144
155
  > **CC-Switchユーザー向けの注意**: [CC-Switch](https://github.com/farion1231/cc-switch)を[ルーティングサービス](https://www.ccswitch.io/en/docs?section=proxy&item=service)有効で使用している場合、追加設定なしで`llm.url`をCC-Switchのプロキシアドレスに向けることができます:
@@ -278,8 +289,11 @@ ocr review \
278
289
  |---------|-------|-------------|
279
290
  | `ocr review` | `ocr r` | コードレビューを開始 |
280
291
  | `ocr rules check <file>` | — | ファイルパスに適用されるレビュールールをプレビュー |
292
+ | `ocr config provider` | — | 対話的プロバイダーセットアップ(ビルトイン、カスタム、手動) |
293
+ | `ocr config model` | — | アクティブなプロバイダーの対話的モデル選択 |
281
294
  | `ocr config set <key> <value>` | — | 設定値をセット |
282
295
  | `ocr llm test` | — | LLMの疎通テスト |
296
+ | `ocr llm providers` | — | ビルトインLLMプロバイダーを一覧表示 |
283
297
  | `ocr viewer` | `ocr v` | `localhost:5483`でWebUIセッションビューアーを起動 |
284
298
  | `ocr version` | — | バージョン情報を表示 |
285
299
 
@@ -305,6 +319,11 @@ ocr review \
305
319
  ## 例
306
320
 
307
321
  ```bash
322
+ # 対話的プロバイダーとモデルのセットアップ
323
+ ocr config provider
324
+ ocr config model
325
+ ocr llm providers
326
+
308
327
  # レビュー対象ファイルをプレビュー(LLM呼び出しなし)
309
328
  ocr review --preview
310
329
  ocr review -c abc123 -p
@@ -425,6 +444,13 @@ OCRは4層の優先度チェーンを使ってレビュールールを解決し
425
444
 
426
445
  | キー | 型 | 例 |
427
446
  |-----|------|---------|
447
+ | `provider` | string | `anthropic` \| `openai` \| `dashscope` \| `deepseek` \| `z-ai` |
448
+ | `providers.<name>.api_key` | string | プロバイダー固有のAPIキー |
449
+ | `providers.<name>.url` | string | プロバイダーのベースURLオーバーライド |
450
+ | `providers.<name>.protocol` | string | `anthropic` \| `openai` |
451
+ | `providers.<name>.model` | string | プロバイダーのモデル名 |
452
+ | `providers.<name>.auth_header` | string | `x-api-key` \| `authorization` |
453
+ | `custom_providers.<name>.*` | — | `providers.<name>.*`と同じフィールド |
428
454
  | `llm.url` | string | `https://api.openai.com/v1/chat/completions` |
429
455
  | `llm.auth_token` | string | `sk-xxxxxxx` |
430
456
  | `llm.auth_header` | string | Anthropicのみ:`x-api-key` \| `authorization` |
package/README.ko-KR.md CHANGED
@@ -113,18 +113,22 @@ sudo cp dist/opencodereview /usr/local/bin/ocr
113
113
 
114
114
  **코드 리뷰를 실행하기 전에 반드시 LLM을 설정해야 합니다.**
115
115
 
116
+ **Option A: 대화형 설정 (권장)**
117
+
118
+ ```bash
119
+ ocr config provider # built-in provider 선택 또는 custom provider 추가
120
+ ocr config model # 활성 provider의 model 선택
121
+ ```
122
+
123
+ ![Provider setup](imgs/providers.jpg)
124
+
125
+ **Option B: 수동 설정**
126
+
116
127
  ```bash
117
- # Option A: 대화형 config
118
128
  ocr config set llm.url https://api.anthropic.com/v1/messages
119
129
  ocr config set llm.auth_token your-api-key-here
120
130
  ocr config set llm.model claude-opus-4-6
121
131
  ocr config set llm.use_anthropic true
122
-
123
- # Option B: 환경 변수(가장 높은 우선순위)
124
- export OCR_LLM_URL=https://api.anthropic.com/v1/messages
125
- export OCR_LLM_TOKEN=your-api-key-here
126
- export OCR_LLM_MODEL=claude-opus-4-6
127
- export OCR_USE_ANTHROPIC=true
128
132
  ```
129
133
 
130
134
  config는 `~/.opencodereview/config.json`에 저장됩니다.
@@ -133,12 +137,19 @@ config는 `~/.opencodereview/config.json`에 저장됩니다.
133
137
 
134
138
  ```bash
135
139
  ocr config set llm.auth_header x-api-key
136
- # 또는
137
- export OCR_LLM_AUTH_HEADER=x-api-key
138
140
  ```
139
141
 
140
142
  지원되는 값: `x-api-key`, `authorization` (별칭: `bearer`). 그 외 값은 오류로 처리됩니다.
141
143
 
144
+ **Option C: 환경 변수(가장 높은 우선순위)**
145
+
146
+ ```bash
147
+ export OCR_LLM_URL=https://api.anthropic.com/v1/messages
148
+ export OCR_LLM_TOKEN=your-api-key-here
149
+ export OCR_LLM_MODEL=claude-opus-4-6
150
+ export OCR_USE_ANTHROPIC=true
151
+ ```
152
+
142
153
  Claude Code 환경 변수(`ANTHROPIC_BASE_URL`, `ANTHROPIC_AUTH_TOKEN`, `ANTHROPIC_MODEL`)와도 호환되며, `~/.zshrc` / `~/.bashrc`의 export도 파싱합니다.
143
154
 
144
155
  > **CC-Switch 사용자 참고**: [CC-Switch](https://github.com/farion1231/cc-switch)를 [routing service](https://www.ccswitch.io/en/docs?section=proxy&item=service)와 함께 사용한다면, 추가 설정 없이 `llm.url`을 CC-Switch proxy 주소로 지정할 수 있습니다.
@@ -278,8 +289,11 @@ ocr review \
278
289
  |---------|-------|-------------|
279
290
  | `ocr review` | `ocr r` | 코드 리뷰 시작 |
280
291
  | `ocr rules check <file>` | - | 파일 경로에 적용될 리뷰 rule 미리보기 |
292
+ | `ocr config provider` | - | 대화형 provider 설정 (built-in, custom, 수동) |
293
+ | `ocr config model` | - | 활성 provider의 대화형 model 선택 |
281
294
  | `ocr config set <key> <value>` | - | config 값 설정 |
282
295
  | `ocr llm test` | - | LLM 연결 테스트 |
296
+ | `ocr llm providers` | - | built-in LLM provider 목록 표시 |
283
297
  | `ocr viewer` | `ocr v` | `localhost:5483`에서 WebUI session viewer 실행 |
284
298
  | `ocr version` | - | version 정보 표시 |
285
299
 
@@ -305,6 +319,11 @@ ocr review \
305
319
  ## Examples
306
320
 
307
321
  ```bash
322
+ # 대화형 provider 및 model 설정
323
+ ocr config provider
324
+ ocr config model
325
+ ocr llm providers
326
+
308
327
  # 리뷰 대상 파일 미리보기(LLM call 없음)
309
328
  ocr review --preview
310
329
  ocr review -c abc123 -p
@@ -383,6 +402,13 @@ Config file: `~/.opencodereview/config.json`
383
402
 
384
403
  | Key | Type | Example |
385
404
  |-----|------|---------|
405
+ | `provider` | string | `anthropic` \| `openai` \| `dashscope` \| `deepseek` \| `z-ai` |
406
+ | `providers.<name>.api_key` | string | Provider별 API key |
407
+ | `providers.<name>.url` | string | Provider base URL override |
408
+ | `providers.<name>.protocol` | string | `anthropic` \| `openai` |
409
+ | `providers.<name>.model` | string | Provider의 model 이름 |
410
+ | `providers.<name>.auth_header` | string | `x-api-key` \| `authorization` |
411
+ | `custom_providers.<name>.*` | — | `providers.<name>.*`과 동일한 필드 |
386
412
  | `llm.url` | string | `https://api.openai.com/v1/chat/completions` |
387
413
  | `llm.auth_token` | string | `sk-xxxxxxx` |
388
414
  | `llm.auth_header` | string | Anthropic only: `x-api-key` \| `authorization` |
package/README.md CHANGED
@@ -113,18 +113,22 @@ sudo cp dist/opencodereview /usr/local/bin/ocr
113
113
 
114
114
  **You must configure an LLM before reviewing code.**
115
115
 
116
+ **Option A: Interactive setup (Recommended)**
117
+
118
+ ```bash
119
+ ocr config provider # Select a built-in provider or add a custom one
120
+ ocr config model # Pick a model for the active provider
121
+ ```
122
+
123
+ ![Provider setup](imgs/providers.jpg)
124
+
125
+ **Option B: Manual config**
126
+
116
127
  ```bash
117
- # Option A: Interactive config
118
128
  ocr config set llm.url https://api.anthropic.com/v1/messages
119
129
  ocr config set llm.auth_token your-api-key-here
120
130
  ocr config set llm.model claude-opus-4-6
121
131
  ocr config set llm.use_anthropic true
122
-
123
- # Option B: Environment variables (highest priority)
124
- export OCR_LLM_URL=https://api.anthropic.com/v1/messages
125
- export OCR_LLM_TOKEN=your-api-key-here
126
- export OCR_LLM_MODEL=claude-opus-4-6
127
- export OCR_USE_ANTHROPIC=true
128
132
  ```
129
133
 
130
134
  Config is stored in `~/.opencodereview/config.json`.
@@ -133,12 +137,19 @@ Config is stored in `~/.opencodereview/config.json`.
133
137
 
134
138
  ```bash
135
139
  ocr config set llm.auth_header x-api-key
136
- # or
137
- export OCR_LLM_AUTH_HEADER=x-api-key
138
140
  ```
139
141
 
140
142
  Supported values: `x-api-key`, `authorization` (alias: `bearer`). Other values are rejected with an error.
141
143
 
144
+ **Option C: Environment variables (highest priority)**
145
+
146
+ ```bash
147
+ export OCR_LLM_URL=https://api.anthropic.com/v1/messages
148
+ export OCR_LLM_TOKEN=your-api-key-here
149
+ export OCR_LLM_MODEL=claude-opus-4-6
150
+ export OCR_USE_ANTHROPIC=true
151
+ ```
152
+
142
153
  It is also compatible with Claude Code environment variables (`ANTHROPIC_BASE_URL`, `ANTHROPIC_AUTH_TOKEN`, `ANTHROPIC_MODEL`) and parses `~/.zshrc` / `~/.bashrc` for those exports.
143
154
 
144
155
  > **Note for CC-Switch Users**: If you are using [CC-Switch](https://github.com/farion1231/cc-switch) with [routing service](https://www.ccswitch.io/en/docs?section=proxy&item=service) enabled, you can point `llm.url` to the CC-Switch proxy address without additional configuration:
@@ -280,8 +291,11 @@ See the [`examples/`](./examples/) directory for integration examples:
280
291
  |---------|-------|-------------|
281
292
  | `ocr review` | `ocr r` | Start a code review |
282
293
  | `ocr rules check <file>` | — | Preview which review rule applies to a file path |
294
+ | `ocr config provider` | — | Interactive provider setup (built-in, custom, or manual) |
295
+ | `ocr config model` | — | Interactive model selection for the active provider |
283
296
  | `ocr config set <key> <value>` | — | Set configuration values |
284
297
  | `ocr llm test` | — | Test LLM connectivity |
298
+ | `ocr llm providers` | — | List built-in LLM providers |
285
299
  | `ocr viewer` | `ocr v` | Launch WebUI session viewer on `localhost:5483` |
286
300
  | `ocr version` | — | Show version info |
287
301
 
@@ -307,6 +321,11 @@ See the [`examples/`](./examples/) directory for integration examples:
307
321
  ## Examples
308
322
 
309
323
  ```bash
324
+ # Interactive provider and model setup
325
+ ocr config provider
326
+ ocr config model
327
+ ocr llm providers
328
+
310
329
  # Preview which files will be reviewed (no LLM calls)
311
330
  ocr review --preview
312
331
  ocr review -c abc123 -p
@@ -427,6 +446,13 @@ Config file: `~/.opencodereview/config.json`
427
446
 
428
447
  | Key | Type | Example |
429
448
  |-----|------|---------|
449
+ | `provider` | string | `anthropic` \| `openai` \| `dashscope` \| `deepseek` \| `z-ai` |
450
+ | `providers.<name>.api_key` | string | Provider-specific API key |
451
+ | `providers.<name>.url` | string | Provider base URL override |
452
+ | `providers.<name>.protocol` | string | `anthropic` \| `openai` |
453
+ | `providers.<name>.model` | string | Model name for the provider |
454
+ | `providers.<name>.auth_header` | string | `x-api-key` \| `authorization` |
455
+ | `custom_providers.<name>.*` | — | Same fields as `providers.<name>.*` |
430
456
  | `llm.url` | string | `https://api.openai.com/v1/chat/completions` |
431
457
  | `llm.auth_token` | string | `sk-xxxxxxx` |
432
458
  | `llm.auth_header` | string | Anthropic only: `x-api-key` \| `authorization` |
package/README.zh-CN.md CHANGED
@@ -113,18 +113,22 @@ sudo cp dist/opencodereview /usr/local/bin/ocr
113
113
 
114
114
  **在审查代码之前,必须先配置 LLM。**
115
115
 
116
+ **方式 A:交互式设置(推荐)**
117
+
118
+ ```bash
119
+ ocr config provider # 选择内置供应商或添加自定义供应商
120
+ ocr config model # 为当前供应商选择模型
121
+ ```
122
+
123
+ ![Provider setup](imgs/providers.jpg)
124
+
125
+ **方式 B:手动配置**
126
+
116
127
  ```bash
117
- # 方式 A:交互式配置
118
128
  ocr config set llm.url https://api.anthropic.com/v1/messages
119
129
  ocr config set llm.auth_token your-api-key-here
120
130
  ocr config set llm.model claude-opus-4-6
121
131
  ocr config set llm.use_anthropic true
122
-
123
- # 方式 B:环境变量(优先级最高)
124
- export OCR_LLM_URL=https://api.anthropic.com/v1/messages
125
- export OCR_LLM_TOKEN=your-api-key-here
126
- export OCR_LLM_MODEL=claude-opus-4-6
127
- export OCR_USE_ANTHROPIC=true
128
132
  ```
129
133
 
130
134
  配置存储于 `~/.opencodereview/config.json`。
@@ -133,12 +137,19 @@ export OCR_USE_ANTHROPIC=true
133
137
 
134
138
  ```bash
135
139
  ocr config set llm.auth_header x-api-key
136
- # 或
137
- export OCR_LLM_AUTH_HEADER=x-api-key
138
140
  ```
139
141
 
140
142
  支持的值:`x-api-key`、`authorization`(别名:`bearer`)。其他值会直接报错。
141
143
 
144
+ **方式 C:环境变量(优先级最高)**
145
+
146
+ ```bash
147
+ export OCR_LLM_URL=https://api.anthropic.com/v1/messages
148
+ export OCR_LLM_TOKEN=your-api-key-here
149
+ export OCR_LLM_MODEL=claude-opus-4-6
150
+ export OCR_USE_ANTHROPIC=true
151
+ ```
152
+
142
153
  同时兼容了 Claude Code 环境变量(`ANTHROPIC_BASE_URL`、`ANTHROPIC_AUTH_TOKEN`、`ANTHROPIC_MODEL`),并解析 `~/.zshrc` / `~/.bashrc` 中的相关导出。
143
154
 
144
155
  > **CC-Switch 用户特别提醒**:如果你使用 [CC-Switch](https://github.com/farion1231/cc-switch) 并开启了[路由服务](https://www.ccswitch.io/zh/docs?section=proxy&item=service),可以将 `llm.url` 配置成 CC-Switch 启动的代理地址,无需额外配置:
@@ -278,8 +289,11 @@ ocr review \
278
289
  |------|------|------|
279
290
  | `ocr review` | `ocr r` | 开始代码审查 |
280
291
  | `ocr rules check <file>` | — | 预览某个文件路径生效的审查规则 |
292
+ | `ocr config provider` | — | 交互式供应商设置(内置、自定义或手动) |
293
+ | `ocr config model` | — | 为当前供应商交互式选择模型 |
281
294
  | `ocr config set <key> <value>` | — | 设置配置项 |
282
295
  | `ocr llm test` | — | 测试 LLM 连通性 |
296
+ | `ocr llm providers` | — | 列出内置 LLM 供应商 |
283
297
  | `ocr viewer` | `ocr v` | 启动 WebUI 会话查看器,地址 `localhost:5483` |
284
298
  | `ocr version` | — | 显示版本信息 |
285
299
 
@@ -305,6 +319,11 @@ ocr review \
305
319
  ## 示例
306
320
 
307
321
  ```bash
322
+ # 交互式供应商和模型设置
323
+ ocr config provider
324
+ ocr config model
325
+ ocr llm providers
326
+
308
327
  # 预览将被审查的文件(不调用 LLM)
309
328
  ocr review --preview
310
329
  ocr review -c abc123 -p
@@ -415,6 +434,13 @@ OCR 通过四层优先级链解析评审规则。每层采用首次匹配原则
415
434
 
416
435
  | 键 | 类型 | 示例 |
417
436
  |----|------|------|
437
+ | `provider` | string | `anthropic` \| `openai` \| `dashscope` \| `deepseek` \| `z-ai` |
438
+ | `providers.<name>.api_key` | string | 供应商 API 密钥 |
439
+ | `providers.<name>.url` | string | 供应商 Base URL 覆盖 |
440
+ | `providers.<name>.protocol` | string | `anthropic` \| `openai` |
441
+ | `providers.<name>.model` | string | 供应商模型名称 |
442
+ | `providers.<name>.auth_header` | string | `x-api-key` \| `authorization` |
443
+ | `custom_providers.<name>.*` | — | 与 `providers.<name>.*` 相同的字段 |
418
444
  | `llm.url` | string | `https://api.openai.com/v1/chat/completions` |
419
445
  | `llm.auth_token` | string | `sk-xxxxxxx` |
420
446
  | `llm.auth_header` | string | 仅 Anthropic:`x-api-key` \| `authorization` |
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alibaba-group/open-code-review",
3
- "version": "1.3.5",
3
+ "version": "1.3.6",
4
4
  "description": "OpenCodeReview CLI — AI-powered code review tool",
5
5
  "bin": {
6
6
  "ocr": "bin/ocr.js"