Skip to content

Commit 86724c3

Browse files
docs(pages): simplify claude-code prerequisites, recommend delegation mode (#391)
Remove redundant auto-install hints (the command handles this transparently) and replace the LLM prerequisite note with a tip pointing users to Delegation Mode as a zero-config alternative.
1 parent 087807a commit 86724c3

3 files changed

Lines changed: 10 additions & 19 deletions

File tree

pages/src/content/docs/en/integrations/claude-code.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,9 @@ reads commands from, and invoke it the way your agent invokes
6464
commands. The prompt body is agent-agnostic — it just tells the model
6565
which `ocr` flags to pick and how to triage the output.
6666

67-
> **Prerequisite:** the command will install the `ocr` CLI itself the
68-
> first time it runs (via `npm install -g @alibaba-group/open-code-review`)
69-
> if the binary isn't on `PATH`. You **do** need an LLM configured up
70-
> front — the command will fail if `ocr llm test` can't reach one. See
71-
> [Configuration](../../configuration/).
67+
> **Tip:** if you don't want to configure an LLM yourself, try
68+
> [Delegation Mode](../delegate/) — it lets the host agent (Claude Code)
69+
> supply the model, so no separate LLM setup is needed.
7270
7371
## Use
7472

@@ -94,10 +92,8 @@ The command prompt is short — three steps:
9492

9593
1. **Run the review.** Invoke `ocr review --audience agent` with the
9694
flags inferred from your request (plus an optional `--background`
97-
when you've described requirement context). If the `ocr` binary
98-
isn't on `PATH`, the command auto-installs it via
99-
`npm i -g @alibaba-group/open-code-review` and continues. Output is
100-
captured with a 5-minute timeout.
95+
when you've described requirement context). Output is captured with
96+
a 5-minute timeout.
10197
2. **Filter and evaluate.** Classify each comment as **High** /
10298
**Medium** / **Low**. Low-confidence comments (likely false
10399
positives, nitpicks, lacking context) are dropped silently; the

pages/src/content/docs/ja/integrations/claude-code.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ curl -o ~/.claude/commands/open-code-review.md \
5252

5353
コマンドファイルは単一の frontmatter フィールドを持つ純粋な markdown です——Claude Code 固有の内容は一切含まれていません。あなたの agent が同様の **command** 規約(ディレクトリから呼び出し可能なコマンドとしてロードされる markdown prompt)をサポートしている場合、上記のファイルコピー方法がインストール経路になります。`open-code-review.md` を agent がコマンドを読み込むディレクトリに配置し、agent のコマンド呼び出し方法に従って呼び出してください。prompt 本文は agent に依存しません——モデルに対して、どの `ocr` 引数を選び、出力をどのように分類するかを伝えるだけです。
5454

55-
> **前提条件:** 初回実行時、バイナリが `PATH` 上に存在しない場合、コマンドは
56-
> `npm install -g @alibaba-group/open-code-review` を通じて)`ocr` CLI を自動的にインストールします。ただし、LLM は事前に設定しておく**必要があります**——`ocr llm test` が接続できない場合、コマンドは失敗します。[設定](../../configuration/)を参照してください。
55+
> **ヒント:** LLM を自分で設定したくない場合は、[委任モード](../delegate/)をお試しください——ホスト agent(Claude Code)がモデルを提供するため、別途 LLM を設定する必要がありません。
5756
5857
## 使い方
5958

@@ -74,7 +73,7 @@ prompt はあなたのリクエストを解析し、正しい `ocr review` 引
7473
コマンドの prompt はとても短く、3 ステップです。
7574

7675
1. **レビューの実行。** あなたのリクエストから推論した引数を用いて `ocr review --audience agent`
77-
を呼び出します(要件コンテキストが記述されている場合はオプションの `--background` を追加)。`ocr` バイナリが `PATH` 上に無い場合、コマンドは `npm i -g @alibaba-group/open-code-review` を通じて自動インストールして続行します。出力は 5 分のタイムアウト内で取得されます。
76+
を呼び出します(要件コンテキストが記述されている場合はオプションの `--background` を追加)。出力は 5 分のタイムアウト内で取得されます。
7877
2. **フィルタリングと評価。** 各コメントを **High** / **Medium** / **Low** に分類します。低信頼度(誤検知の疑い、些細な指摘、コンテキスト不足)のコメントは黙って破棄され、その他は表示されます。
7978
3. **修正。** 採用すべき High/Medium 項目に対して修正を自動的に適用します。
8079
[Agent Skill](../agent-skill/) と異なり、このコマンドは**デフォルトで自動修正します**——「レビューして片付ける」ワークフローには適した選択であり、「diff を見せてほしい」ワークフローには向きません。

pages/src/content/docs/zh/integrations/claude-code.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,8 @@ markdown prompt),上面的文件复制方法就是安装路径:把 `open-c
5757
放进你的 agent 读取命令的目录,按你的 agent 调用命令的方式调用它。prompt 正文
5858
与 agent 无关——它只告诉模型选哪些 `ocr` 参数以及如何分级输出。
5959

60-
> **前置条件:** 首次运行时命令会自行安装 `ocr` CLI
61-
> (通过 `npm install -g @alibaba-group/open-code-review`),前提是二进制不在
62-
> `PATH` 上。你**确实**需要预先配置好 LLM——若 `ocr llm test` 连不上,命令会
63-
> 失败。见[配置](../../configuration/)
60+
> **提示:** 如果不想自行配置 LLM,可以试试[委托模式](../delegate/)——它让宿主
61+
> agent(Claude Code)提供模型,无需额外的 LLM 配置。
6462
6563
## 使用
6664

@@ -83,9 +81,7 @@ prompt 解析你的请求并选择正确的 `ocr review` 参数:无参数 →
8381
命令 prompt 很短——三步:
8482

8583
1. **运行评审。** 用从你请求推断的参数调用 `ocr review --audience agent`
86-
(描述了需求上下文时加可选 `--background`)。若 `ocr` 二进制不在 `PATH`
87-
命令通过 `npm i -g @alibaba-group/open-code-review` 自动安装并继续。输出在 5
88-
分钟超时内捕获。
84+
(描述了需求上下文时加可选 `--background`)。输出在 5 分钟超时内捕获。
8985
2. **过滤与评估。** 把每条评论分为 **High** / **Medium** / **Low**。低置信
9086
(疑似误报、吹毛求疵、缺上下文)评论被静默丢弃;其余展示。
9187
3. **修复。** 对值得采纳的 High/Medium 项自动应用修复。与

0 commit comments

Comments
 (0)