Skip to content

Commit ce11f37

Browse files
docs: sync ocr scan documentation to localized READMEs
Commit 18797f8 added the ocr scan feature but only updated the English README. This syncs all six categories of changes (intro paragraph, quick start examples, commands table, --exclude flag, ocr scan flags section, and scan usage examples) to zh-CN, ja-JP, ko-KR, and ru-RU.
1 parent 18797f8 commit ce11f37

4 files changed

Lines changed: 176 additions & 8 deletions

File tree

README.ja-JP.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
Open Code ReviewはAIを活用したコードレビューCLIツールです。もともとはAlibaba Group社内の公式AIコードレビューアシスタントとして誕生し、過去2年間で数万人の開発者にサービスを提供し、数百万件のコード欠陥を発見してきました。大規模な環境で徹底的に検証された後、コミュニティ向けのオープンソースプロジェクトとして公開されました。モデルのエンドポイントを設定するだけで使い始められます。
3737

38-
Gitのdiffを読み取り、変更されたファイルをツール利用機能を持つエージェント経由で設定可能なLLMに送信し、行レベルの精度で構造化されたレビューコメントを生成します。エージェントはファイル全体の内容を読み取り、コードベースを検索し、コンテキストのために他の変更ファイルを参照し、深いレビューを生成できます — 単なる表面的なdiffへのフィードバックではありません。
38+
Gitのdiffを読み取り、変更されたファイルをツール利用機能を持つエージェント経由で設定可能なLLMに送信し、行レベルの精度で構造化されたレビューコメントを生成します。エージェントはファイル全体の内容を読み取り、コードベースを検索し、コンテキストのために他の変更ファイルを参照し、深いレビューを生成できます — 単なる表面的なdiffへのフィードバックではありません。diffレビュー以外にも、`ocr scan` はファイル全体をレビューできます。不慣れなコードベースの監査や、意味のあるdiffがないディレクトリの検査に便利です。
3939

4040
![Highlights](imgs/highlights-en.png)
4141

@@ -227,6 +227,10 @@ ocr review --from main --to feature-branch
227227

228228
# 単一コミット
229229
ocr review --commit abc123
230+
231+
# フルファイルスキャン — diffではなくファイル全体をレビュー(git履歴不要)
232+
ocr scan # リポジトリ全体をスキャン
233+
ocr scan --path internal/agent # ディレクトリまたは特定のファイルをスキャン
230234
```
231235

232236
### コーディングエージェントとの統合
@@ -336,7 +340,8 @@ ocr review \
336340

337341
| コマンド | エイリアス | 説明 |
338342
|---------|-------|-------------|
339-
| `ocr review` | `ocr r` | コードレビューを開始 |
343+
| `ocr review` | `ocr r` | diffベースのコードレビューを開始 |
344+
| `ocr scan` | `ocr s` | ファイル全体をレビュー(diff不要) |
340345
| `ocr rules check <file>` || ファイルパスに適用されるレビュールールをプレビュー |
341346
| `ocr config provider` || 対話的プロバイダーセットアップ(ビルトイン、カスタム、手動) |
342347
| `ocr config model` || アクティブなプロバイダーの対話的モデル選択 |
@@ -355,6 +360,7 @@ ocr review \
355360
| `--from` ||| ソースref(例:`main`|
356361
| `--to` ||| ターゲットref(例:`feature-branch`|
357362
| `--commit` | `-c` || レビュー対象の単一コミット |
363+
| `--exclude` ||| カンマ区切りのgitignoreスタイルパターンでスキップ対象を指定;rule.jsonのexcludesとマージ |
358364
| `--preview` | `-p` | `false` | LLMを実行せずにレビュー対象ファイルをプレビュー |
359365
| `--format` | `-f` | `text` | 出力形式:`text`または`json` |
360366
| `--concurrency` || `8` | ファイルレビューの最大同時実行数 |
@@ -367,6 +373,27 @@ ocr review \
367373
| `--max-git-procs` || 組み込み値 | gitサブプロセスの最大同時実行数 |
368374
| `--tools` ||| カスタムJSONツール設定へのパス |
369375

376+
### `ocr scan`のフラグ
377+
378+
`ocr scan` はdiffではなくファイル全体をレビューします — 不慣れなコードベースの監査、マイグレーション前のスキャン、意味のあるdiffがないディレクトリなどに有用です。非gitディレクトリでも動作します(`.gitignore` を尊重するファイルシステムウォークにフォールバック)。
379+
380+
| フラグ | 短縮形 | デフォルト | 説明 |
381+
|------|-----------|---------|-------------|
382+
| `--path` || リポジトリ全体 | カンマ区切りのスキャン対象ディレクトリ/ファイル |
383+
| `--exclude` ||| カンマ区切りのgitignoreスタイルパターンでスキップ対象を指定;rule.jsonのexcludesとマージ |
384+
| `--preview` | `-p` | `false` | LLMを実行せずにスキャン対象ファイルを一覧表示 |
385+
| `--max-tokens-budget` || `0`(無制限) | トークン使用量の上限;超過するとディスパッチを停止 |
386+
| `--no-plan` || `false` | ファイルごとのプランニング前処理をスキップ |
387+
| `--no-dedup` || `false` | バッチごとの類似コメント重複排除をスキップ |
388+
| `--no-summary` || `false` | プロジェクトレベルのサマリーをスキップ |
389+
| `--batch` || `by-language` | バッチ戦略:`none``by-language`、または `by-directory` |
390+
| `--format` | `-f` | `text` | 出力形式:`text` または `json`(JSONには `project_summary` フィールドを含む) |
391+
| `--concurrency` || `8` | 最大同時ファイルスキャン数 |
392+
| `--rule` ||| カスタムJSONレビュールールへのパス |
393+
| `--repo` || カレントディレクトリ | スキャン対象のリポジトリまたはディレクトリルート |
394+
395+
各実行前に、`ocr scan` はおおまかなトークンコスト見積もりを表示します。`--preview` でまずファイルリストを確認し、`--max-tokens-budget` で大規模リポジトリの支出を制限できます。
396+
370397
##
371398

372399
```bash
@@ -405,6 +432,21 @@ ocr review --rule /path/to/my-rules.json
405432
ocr rules check src/main/java/com/example/Foo.java
406433
ocr rules check --rule custom.json src/main/resources/mapper/UserMapper.xml
407434

435+
# フルファイルスキャン:まずファイルリストをプレビュー(LLM呼び出しなし)
436+
ocr scan --preview
437+
438+
# リポジトリ全体をスキャン、支出を約500kトークンに制限
439+
ocr scan --max-tokens-budget 500000
440+
441+
# サブディレクトリをスキャン、生成ファイル/テストファイルをスキップ
442+
ocr scan --path internal --exclude '**/*_test.go,**/generated/**'
443+
444+
# 非gitディレクトリをJSON出力でスキャン(project_summaryを含む)
445+
ocr scan --repo /path/to/plain/dir --format json
446+
447+
# 最速スキャン:プランニング、重複排除、プロジェクトサマリーをスキップ
448+
ocr scan --no-plan --no-dedup --no-summary
449+
408450
# ブラウザでレビューセッション履歴を表示
409451
ocr viewer
410452
ocr viewer --addr :3000

README.ko-KR.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
Open Code Review는 AI 기반 코드 리뷰 CLI 도구입니다. Alibaba Group의 내부 공식 AI 코드 리뷰 어시스턴트에서 시작했으며, 지난 2년 동안 수만 명의 개발자에게 제공되어 수백만 건의 코드 결함을 찾아냈습니다. 대규모 환경에서 충분히 검증한 뒤 커뮤니티를 위해 오픈 소스 프로젝트로 공개했습니다. 모델 endpoint만 설정하면 바로 사용할 수 있습니다.
3737

38-
이 도구는 Git diff를 읽고, 변경 파일을 tool-use 기능을 가진 agent를 통해 설정 가능한 LLM으로 전달한 뒤, 라인 단위 위치 정보가 포함된 구조화된 리뷰 코멘트를 생성합니다. agent는 전체 파일 내용 읽기, 코드베이스 검색, 다른 변경 파일 확인 등을 통해 맥락을 확보하고 표면적인 diff 피드백이 아닌 깊이 있는 리뷰를 수행할 수 있습니다.
38+
이 도구는 Git diff를 읽고, 변경 파일을 tool-use 기능을 가진 agent를 통해 설정 가능한 LLM으로 전달한 뒤, 라인 단위 위치 정보가 포함된 구조화된 리뷰 코멘트를 생성합니다. agent는 전체 파일 내용 읽기, 코드베이스 검색, 다른 변경 파일 확인 등을 통해 맥락을 확보하고 표면적인 diff 피드백이 아닌 깊이 있는 리뷰를 수행할 수 있습니다. diff 리뷰 외에도 `ocr scan`은 전체 파일을 리뷰할 수 있어, 익숙하지 않은 코드베이스를 감사하거나 의미 있는 diff가 없는 디렉터리를 검토하는 데 유용합니다.
3939

4040
![Highlights](imgs/highlights-en.png)
4141

@@ -227,6 +227,10 @@ ocr review --from main --to feature-branch
227227

228228
# 단일 commit
229229
ocr review --commit abc123
230+
231+
# 전체 파일 스캔 — diff 대신 파일 전체를 리뷰 (git 이력 불필요)
232+
ocr scan # 전체 repository 스캔
233+
ocr scan --path internal/agent # 디렉터리 또는 특정 파일 스캔
230234
```
231235

232236
### Coding Agent와 통합
@@ -336,7 +340,8 @@ ocr review \
336340

337341
| Command | Alias | Description |
338342
|---------|-------|-------------|
339-
| `ocr review` | `ocr r` | 코드 리뷰 시작 |
343+
| `ocr review` | `ocr r` | diff 기반 코드 리뷰 시작 |
344+
| `ocr scan` | `ocr s` | 전체 파일 리뷰 (diff 불필요) |
340345
| `ocr rules check <file>` | - | 파일 경로에 적용될 리뷰 rule 미리보기 |
341346
| `ocr config provider` | - | 대화형 provider 설정 (built-in, custom, 수동) |
342347
| `ocr config model` | - | 활성 provider의 대화형 model 선택 |
@@ -355,6 +360,7 @@ ocr review \
355360
| `--from` | - | - | Source ref 예: `main` |
356361
| `--to` | - | - | Target ref 예: `feature-branch` |
357362
| `--commit` | `-c` | - | 리뷰할 단일 commit |
363+
| `--exclude` | - | - | 건너뛸 파일의 쉼표 구분 gitignore 스타일 패턴; rule.json의 excludes와 병합 |
358364
| `--preview` | `-p` | `false` | LLM 실행 없이 리뷰 대상 파일 미리보기 |
359365
| `--format` | `-f` | `text` | Output format: `text` 또는 `json` |
360366
| `--concurrency` | - | `8` | 최대 동시 파일 리뷰 수 |
@@ -367,6 +373,27 @@ ocr review \
367373
| `--max-git-procs` | - | built-in | 최대 동시 git subprocess 수 |
368374
| `--tools` | - | - | custom JSON tools config 경로 |
369375

376+
### `ocr scan` Flags
377+
378+
`ocr scan`은 diff가 아닌 전체 파일을 리뷰합니다 — 익숙하지 않은 코드베이스 감사, 마이그레이션 전 스캔, 의미 있는 diff가 없는 디렉터리 등에 유용합니다. 비-git 디렉터리에서도 작동합니다 (`.gitignore`를 따르는 파일 시스템 탐색으로 폴백).
379+
380+
| Flag | Shorthand | Default | Description |
381+
|------|-----------|---------|-------------|
382+
| `--path` | - | 전체 repo | 스캔할 쉼표 구분 디렉터리/파일 |
383+
| `--exclude` | - | - | 건너뛸 파일의 쉼표 구분 gitignore 스타일 패턴; rule.json의 excludes와 병합 |
384+
| `--preview` | `-p` | `false` | LLM 실행 없이 스캔 대상 파일 목록 표시 |
385+
| `--max-tokens-budget` | - | `0` (무제한) | 총 토큰 사용량 제한; 초과 시 dispatch 중단 |
386+
| `--no-plan` | - | `false` | 파일별 planning 사전 처리 건너뛰기 |
387+
| `--no-dedup` | - | `false` | 배치별 유사 comment 중복 제거 건너뛰기 |
388+
| `--no-summary` | - | `false` | 프로젝트 수준 요약 건너뛰기 |
389+
| `--batch` | - | `by-language` | 배치 전략: `none`, `by-language`, 또는 `by-directory` |
390+
| `--format` | `-f` | `text` | Output format: `text` 또는 `json` (JSON에 `project_summary` 필드 포함) |
391+
| `--concurrency` | - | `8` | 최대 동시 파일 스캔 수 |
392+
| `--rule` | - | - | custom JSON review rules 경로 |
393+
| `--repo` | - | current dir | 스캔할 repository 또는 디렉터리 루트 |
394+
395+
각 실행 전에 `ocr scan`은 대략적인 토큰 비용 추정치를 출력합니다. `--preview`로 먼저 파일 목록을 확인하고, `--max-tokens-budget`으로 대규모 repository의 비용을 제한할 수 있습니다.
396+
370397
## Examples
371398

372399
```bash
@@ -405,6 +432,21 @@ ocr review --rule /path/to/my-rules.json
405432
ocr rules check src/main/java/com/example/Foo.java
406433
ocr rules check --rule custom.json src/main/resources/mapper/UserMapper.xml
407434

435+
# 전체 파일 스캔: 먼저 파일 목록 미리보기 (LLM call 없음)
436+
ocr scan --preview
437+
438+
# 전체 repo 스캔, 비용을 ~500k 토큰으로 제한
439+
ocr scan --max-tokens-budget 500000
440+
441+
# 하위 디렉터리 스캔, 생성/테스트 파일 건너뛰기
442+
ocr scan --path internal --exclude '**/*_test.go,**/generated/**'
443+
444+
# 비-git 디렉터리를 JSON output으로 스캔 (project_summary 포함)
445+
ocr scan --repo /path/to/plain/dir --format json
446+
447+
# 가장 빠른 스캔: planning, 중복 제거, 프로젝트 요약 건너뛰기
448+
ocr scan --no-plan --no-dedup --no-summary
449+
408450
# browser에서 review session history 보기
409451
ocr viewer
410452
ocr viewer --addr :3000

0 commit comments

Comments
 (0)