@alibaba-group/open-code-review 1.5.1 → 1.6.1

package/README.ja-JP.md

@@ -35,7 +35,7 @@
 
 Open Code ReviewはAIを活用したコードレビューCLIツールです。もともとはAlibaba Group社内の公式AIコードレビューアシスタントとして誕生し、過去2年間で数万人の開発者にサービスを提供し、数百万件のコード欠陥を発見してきました。大規模な環境で徹底的に検証された後、コミュニティ向けのオープンソースプロジェクトとして公開されました。モデルのエンドポイントを設定するだけで使い始められます。
 
-Gitのdiffを読み取り、変更されたファイルをツール利用機能を持つエージェント経由で設定可能なLLMに送信し、行レベルの精度で構造化されたレビューコメントを生成します。エージェントはファイル全体の内容を読み取り、コードベースを検索し、コンテキストのために他の変更ファイルを参照し、深いレビューを生成できます — 単なる表面的なdiffへのフィードバックではありません。
+Gitのdiffを読み取り、変更されたファイルをツール利用機能を持つエージェント経由で設定可能なLLMに送信し、行レベルの精度で構造化されたレビューコメントを生成します。エージェントはファイル全体の内容を読み取り、コードベースを検索し、コンテキストのために他の変更ファイルを参照し、深いレビューを生成できます — 単なる表面的なdiffへのフィードバックではありません。diffレビュー以外にも、`ocr scan` はファイル全体をレビューできます。不慣れなコードベースの監査や、意味のあるdiffがないディレクトリの検査に便利です。
 
 ![Highlights](imgs/highlights-en.png)
 
@@ -227,6 +227,10 @@ ocr review --from main --to feature-branch
 
 # 単一コミット
 ocr review --commit abc123
+
+# フルファイルスキャン — diffではなくファイル全体をレビュー（git履歴不要）
+ocr scan                          # リポジトリ全体をスキャン
+ocr scan --path internal/agent    # ディレクトリまたは特定のファイルをスキャン
 ```
 
 ### コーディングエージェントとの統合
@@ -336,7 +340,8 @@ ocr review \
 
 | コマンド | エイリアス | 説明 |
 |---------|-------|-------------|
-| `ocr review` | `ocr r` | コードレビューを開始 |
+| `ocr review` | `ocr r` | diffベースのコードレビューを開始 |
+| `ocr scan` | `ocr s` | ファイル全体をレビュー（diff不要） |
 | `ocr rules check <file>` | — | ファイルパスに適用されるレビュールールをプレビュー |
 | `ocr config provider` | — | 対話的プロバイダーセットアップ（ビルトイン、カスタム、手動） |
 | `ocr config model` | — | アクティブなプロバイダーの対話的モデル選択 |
@@ -355,6 +360,7 @@ ocr review \
 | `--from` | — | — | ソースref（例：`main`） |
 | `--to` | — | — | ターゲットref（例：`feature-branch`） |
 | `--commit` | `-c` | — | レビュー対象の単一コミット |
+| `--exclude` | — | — | カンマ区切りのgitignoreスタイルパターンでスキップ対象を指定；rule.jsonのexcludesとマージ |
 | `--preview` | `-p` | `false` | LLMを実行せずにレビュー対象ファイルをプレビュー |
 | `--format` | `-f` | `text` | 出力形式：`text`または`json` |
 | `--concurrency` | — | `8` | ファイルレビューの最大同時実行数 |
@@ -367,6 +373,27 @@ ocr review \
 | `--max-git-procs` | — | 組み込み値 | gitサブプロセスの最大同時実行数 |
 | `--tools` | — | — | カスタムJSONツール設定へのパス |
 
+### `ocr scan`のフラグ
+
+`ocr scan` はdiffではなくファイル全体をレビューします — 不慣れなコードベースの監査、マイグレーション前のスキャン、意味のあるdiffがないディレクトリなどに有用です。非gitディレクトリでも動作します（`.gitignore` を尊重するファイルシステムウォークにフォールバック）。
+
+| フラグ | 短縮形 | デフォルト | 説明 |
+|------|-----------|---------|-------------|
+| `--path` | — | リポジトリ全体 | カンマ区切りのスキャン対象ディレクトリ/ファイル |
+| `--exclude` | — | — | カンマ区切りのgitignoreスタイルパターンでスキップ対象を指定；rule.jsonのexcludesとマージ |
+| `--preview` | `-p` | `false` | LLMを実行せずにスキャン対象ファイルを一覧表示 |
+| `--max-tokens-budget` | — | `0`（無制限） | トークン使用量の上限；超過するとディスパッチを停止 |
+| `--no-plan` | — | `false` | ファイルごとのプランニング前処理をスキップ |
+| `--no-dedup` | — | `false` | バッチごとの類似コメント重複排除をスキップ |
+| `--no-summary` | — | `false` | プロジェクトレベルのサマリーをスキップ |
+| `--batch` | — | `by-language` | バッチ戦略：`none`、`by-language`、または `by-directory` |
+| `--format` | `-f` | `text` | 出力形式：`text` または `json`（JSONには `project_summary` フィールドを含む） |
+| `--concurrency` | — | `8` | 最大同時ファイルスキャン数 |
+| `--rule` | — | — | カスタムJSONレビュールールへのパス |
+| `--repo` | — | カレントディレクトリ | スキャン対象のリポジトリまたはディレクトリルート |
+
+各実行前に、`ocr scan` はおおまかなトークンコスト見積もりを表示します。`--preview` でまずファイルリストを確認し、`--max-tokens-budget` で大規模リポジトリの支出を制限できます。
+
 ## 例
 
 ```bash
@@ -405,6 +432,21 @@ ocr review --rule /path/to/my-rules.json
 ocr rules check src/main/java/com/example/Foo.java
 ocr rules check --rule custom.json src/main/resources/mapper/UserMapper.xml
 
+# フルファイルスキャン：まずファイルリストをプレビュー（LLM呼び出しなし）
+ocr scan --preview
+
+# リポジトリ全体をスキャン、支出を約500kトークンに制限
+ocr scan --max-tokens-budget 500000
+
+# サブディレクトリをスキャン、生成ファイル/テストファイルをスキップ
+ocr scan --path internal --exclude '**/*_test.go,**/generated/**'
+
+# 非gitディレクトリをJSON出力でスキャン（project_summaryを含む）
+ocr scan --repo /path/to/plain/dir --format json
+
+# 最速スキャン：プランニング、重複排除、プロジェクトサマリーをスキップ
+ocr scan --no-plan --no-dedup --no-summary
+
 # ブラウザでレビューセッション履歴を表示
 ocr viewer
 ocr viewer --addr :3000

package/README.ko-KR.md

@@ -35,7 +35,7 @@
 
 Open Code Review는 AI 기반 코드 리뷰 CLI 도구입니다. Alibaba Group의 내부 공식 AI 코드 리뷰 어시스턴트에서 시작했으며, 지난 2년 동안 수만 명의 개발자에게 제공되어 수백만 건의 코드 결함을 찾아냈습니다. 대규모 환경에서 충분히 검증한 뒤 커뮤니티를 위해 오픈 소스 프로젝트로 공개했습니다. 모델 endpoint만 설정하면 바로 사용할 수 있습니다.
 
-이 도구는 Git diff를 읽고, 변경 파일을 tool-use 기능을 가진 agent를 통해 설정 가능한 LLM으로 전달한 뒤, 라인 단위 위치 정보가 포함된 구조화된 리뷰 코멘트를 생성합니다. agent는 전체 파일 내용 읽기, 코드베이스 검색, 다른 변경 파일 확인 등을 통해 맥락을 확보하고 표면적인 diff 피드백이 아닌 깊이 있는 리뷰를 수행할 수 있습니다.
+이 도구는 Git diff를 읽고, 변경 파일을 tool-use 기능을 가진 agent를 통해 설정 가능한 LLM으로 전달한 뒤, 라인 단위 위치 정보가 포함된 구조화된 리뷰 코멘트를 생성합니다. agent는 전체 파일 내용 읽기, 코드베이스 검색, 다른 변경 파일 확인 등을 통해 맥락을 확보하고 표면적인 diff 피드백이 아닌 깊이 있는 리뷰를 수행할 수 있습니다. diff 리뷰 외에도 `ocr scan`은 전체 파일을 리뷰할 수 있어, 익숙하지 않은 코드베이스를 감사하거나 의미 있는 diff가 없는 디렉터리를 검토하는 데 유용합니다.
 
 ![Highlights](imgs/highlights-en.png)
 
@@ -227,6 +227,10 @@ ocr review --from main --to feature-branch
 
 # 단일 commit
 ocr review --commit abc123
+
+# 전체 파일 스캔 — diff 대신 파일 전체를 리뷰 (git 이력 불필요)
+ocr scan                          # 전체 repository 스캔
+ocr scan --path internal/agent    # 디렉터리 또는 특정 파일 스캔
 ```
 
 ### Coding Agent와 통합
@@ -336,7 +340,8 @@ ocr review \
 
 | Command | Alias | Description |
 |---------|-------|-------------|
-| `ocr review` | `ocr r` | 코드 리뷰 시작 |
+| `ocr review` | `ocr r` | diff 기반 코드 리뷰 시작 |
+| `ocr scan` | `ocr s` | 전체 파일 리뷰 (diff 불필요) |
 | `ocr rules check <file>` | - | 파일 경로에 적용될 리뷰 rule 미리보기 |
 | `ocr config provider` | - | 대화형 provider 설정 (built-in, custom, 수동) |
 | `ocr config model` | - | 활성 provider의 대화형 model 선택 |
@@ -355,6 +360,7 @@ ocr review \
 | `--from` | - | - | Source ref 예: `main` |
 | `--to` | - | - | Target ref 예: `feature-branch` |
 | `--commit` | `-c` | - | 리뷰할 단일 commit |
+| `--exclude` | - | - | 건너뛸 파일의 쉼표 구분 gitignore 스타일 패턴; rule.json의 excludes와 병합 |
 | `--preview` | `-p` | `false` | LLM 실행 없이 리뷰 대상 파일 미리보기 |
 | `--format` | `-f` | `text` | Output format: `text` 또는 `json` |
 | `--concurrency` | - | `8` | 최대 동시 파일 리뷰 수 |
@@ -367,6 +373,27 @@ ocr review \
 | `--max-git-procs` | - | built-in | 최대 동시 git subprocess 수 |
 | `--tools` | - | - | custom JSON tools config 경로 |
 
+### `ocr scan` Flags
+
+`ocr scan`은 diff가 아닌 전체 파일을 리뷰합니다 — 익숙하지 않은 코드베이스 감사, 마이그레이션 전 스캔, 의미 있는 diff가 없는 디렉터리 등에 유용합니다. 비-git 디렉터리에서도 작동합니다 (`.gitignore`를 따르는 파일 시스템 탐색으로 폴백).
+
+| Flag | Shorthand | Default | Description |
+|------|-----------|---------|-------------|
+| `--path` | - | 전체 repo | 스캔할 쉼표 구분 디렉터리/파일 |
+| `--exclude` | - | - | 건너뛸 파일의 쉼표 구분 gitignore 스타일 패턴; rule.json의 excludes와 병합 |
+| `--preview` | `-p` | `false` | LLM 실행 없이 스캔 대상 파일 목록 표시 |
+| `--max-tokens-budget` | - | `0` (무제한) | 총 토큰 사용량 제한; 초과 시 dispatch 중단 |
+| `--no-plan` | - | `false` | 파일별 planning 사전 처리 건너뛰기 |
+| `--no-dedup` | - | `false` | 배치별 유사 comment 중복 제거 건너뛰기 |
+| `--no-summary` | - | `false` | 프로젝트 수준 요약 건너뛰기 |
+| `--batch` | - | `by-language` | 배치 전략: `none`, `by-language`, 또는 `by-directory` |
+| `--format` | `-f` | `text` | Output format: `text` 또는 `json` (JSON에 `project_summary` 필드 포함) |
+| `--concurrency` | - | `8` | 최대 동시 파일 스캔 수 |
+| `--rule` | - | - | custom JSON review rules 경로 |
+| `--repo` | - | current dir | 스캔할 repository 또는 디렉터리 루트 |
+
+각 실행 전에 `ocr scan`은 대략적인 토큰 비용 추정치를 출력합니다. `--preview`로 먼저 파일 목록을 확인하고, `--max-tokens-budget`으로 대규모 repository의 비용을 제한할 수 있습니다.
+
 ## Examples
 
 ```bash
@@ -405,6 +432,21 @@ ocr review --rule /path/to/my-rules.json
 ocr rules check src/main/java/com/example/Foo.java
 ocr rules check --rule custom.json src/main/resources/mapper/UserMapper.xml
 
+# 전체 파일 스캔: 먼저 파일 목록 미리보기 (LLM call 없음)
+ocr scan --preview
+
+# 전체 repo 스캔, 비용을 ~500k 토큰으로 제한
+ocr scan --max-tokens-budget 500000
+
+# 하위 디렉터리 스캔, 생성/테스트 파일 건너뛰기
+ocr scan --path internal --exclude '**/*_test.go,**/generated/**'
+
+# 비-git 디렉터리를 JSON output으로 스캔 (project_summary 포함)
+ocr scan --repo /path/to/plain/dir --format json
+
+# 가장 빠른 스캔: planning, 중복 제거, 프로젝트 요약 건너뛰기
+ocr scan --no-plan --no-dedup --no-summary
+
 # browser에서 review session history 보기
 ocr viewer
 ocr viewer --addr :3000

package/README.md

@@ -35,7 +35,7 @@
 
 Open Code Review is an AI-powered code review CLI tool. It originated as Alibaba Group's internal official AI code review assistant — over the past two years, it has served tens of thousands of developers and identified millions of code defects. After thorough validation at massive scale, we incubated it into an open source project for the community. Simply configure a model endpoint to get started.
 
-It reads Git diffs, sends changed files to a configurable LLM via an agent with tool-use capabilities, and generates structured review comments with line-level precision. The agent can read full file contents, search the codebase, inspect other changed files for context, and produce deep reviews — not just surface-level diff feedback.
+It reads Git diffs, sends changed files to a configurable LLM via an agent with tool-use capabilities, and generates structured review comments with line-level precision. The agent can read full file contents, search the codebase, inspect other changed files for context, and produce deep reviews — not just surface-level diff feedback. Beyond diff review, `ocr scan` reviews entire files for auditing unfamiliar codebases or directories that have no meaningful diff.
 
 ![Highlights](imgs/highlights-en.png)
 
@@ -227,6 +227,10 @@ ocr review --from main --to feature-branch
 
 # Single commit
 ocr review --commit abc123
+
+# Full-file scan — review whole files instead of a diff (no git history needed)
+ocr scan                          # scan the entire repository
+ocr scan --path internal/agent    # scan a directory or specific files
 ```
 
 ### Integrate with Coding Agents
@@ -338,7 +342,8 @@ See the [`examples/`](./examples/) directory for integration examples:
 
 | Command | Alias | Description |
 |---------|-------|-------------|
-| `ocr review` | `ocr r` | Start a code review |
+| `ocr review` | `ocr r` | Start a diff-based code review |
+| `ocr scan` | `ocr s` | Review whole files (no diff required) |
 | `ocr rules check <file>` | — | Preview which review rule applies to a file path |
 | `ocr config provider` | — | Interactive provider setup (built-in, custom, or manual) |
 | `ocr config model` | — | Interactive model selection for the active provider |
@@ -357,6 +362,7 @@ See the [`examples/`](./examples/) directory for integration examples:
 | `--from` | — | — | Source ref (e.g., `main`) |
 | `--to` | — | — | Target ref (e.g., `feature-branch`) |
 | `--commit` | `-c` | — | Single commit to review |
+| `--exclude` | — | — | Comma-separated gitignore-style patterns to skip; merged with rule.json excludes |
 | `--preview` | `-p` | `false` | Preview which files will be reviewed without running the LLM |
 | `--format` | `-f` | `text` | Output format: `text` or `json` |
 | `--concurrency` | — | `8` | Max concurrent file reviews |
@@ -369,6 +375,30 @@ See the [`examples/`](./examples/) directory for integration examples:
 | `--max-git-procs` | — | built-in | Max concurrent git subprocesses |
 | `--tools` | — | — | Path to custom JSON tools config |
 
+### `ocr scan` Flags
+
+`ocr scan` reviews entire files rather than a diff — useful for auditing an unfamiliar
+codebase, a pre-migration sweep, or any directory with no meaningful diff. It works in
+non-git directories too (it falls back to a filesystem walk that honors `.gitignore`).
+
+| Flag | Shorthand | Default | Description |
+|------|-----------|---------|-------------|
+| `--path` | — | whole repo | Comma-separated dirs/files to scan |
+| `--exclude` | — | — | Comma-separated gitignore-style patterns to skip; merged with rule.json excludes |
+| `--preview` | `-p` | `false` | List which files would be scanned without running the LLM |
+| `--max-tokens-budget` | — | `0` (unlimited) | Cap total token usage; dispatch stops once exceeded |
+| `--no-plan` | — | `false` | Skip the per-file planning pre-pass |
+| `--no-dedup` | — | `false` | Skip per-batch de-duplication of similar comments |
+| `--no-summary` | — | `false` | Skip the project-level summary |
+| `--batch` | — | `by-language` | Batching strategy: `none`, `by-language`, or `by-directory` |
+| `--format` | `-f` | `text` | Output format: `text` or `json` (JSON includes a `project_summary` field) |
+| `--concurrency` | — | `8` | Max concurrent file scans |
+| `--rule` | — | — | Path to custom JSON review rules |
+| `--repo` | — | current dir | Repository or directory root to scan |
+
+Before each run, `ocr scan` prints a rough token-cost estimate. Use `--preview` to see the
+file list first, and `--max-tokens-budget` to cap spend on large repositories.
+
 ## Examples
 
 ```bash
@@ -407,6 +437,21 @@ ocr review --rule /path/to/my-rules.json
 ocr rules check src/main/java/com/example/Foo.java
 ocr rules check --rule custom.json src/main/resources/mapper/UserMapper.xml
 
+# Full-file scan: preview the file list first (no LLM calls)
+ocr scan --preview
+
+# Scan the whole repo, cap spend at ~500k tokens
+ocr scan --max-tokens-budget 500000
+
+# Scan a subdirectory, skipping generated/test files
+ocr scan --path internal --exclude '**/*_test.go,**/generated/**'
+
+# Scan a non-git directory with JSON output (includes project_summary)
+ocr scan --repo /path/to/plain/dir --format json
+
+# Fastest scan: skip planning, dedup, and the project summary
+ocr scan --no-plan --no-dedup --no-summary
+
 # View review session history in browser
 ocr viewer
 ocr viewer --addr :3000

package/README.ru-RU.md

@@ -35,7 +35,7 @@
 
 Open Code Review — это CLI-инструмент для код-ревью на основе ИИ. Он появился как внутренний официальный ИИ-ассистент код-ревью Alibaba Group: за последние два года им воспользовались десятки тысяч разработчиков, и он выявил миллионы дефектов в коде. После тщательной проверки в огромных масштабах мы превратили его в open-source-проект для сообщества. Чтобы начать работу, достаточно настроить эндпоинт модели.
 
-Инструмент читает git-диффы, отправляет изменённые файлы настраиваемой LLM через агента с поддержкой вызова инструментов (tool use) и генерирует структурированные ревью-комментарии с точностью до строки. Агент может читать полное содержимое файлов, искать по кодовой базе, заглядывать в другие изменённые файлы за контекстом и выполнять глубокое ревью — а не только давать поверхностные замечания по диффу.
+Инструмент читает git-диффы, отправляет изменённые файлы настраиваемой LLM через агента с поддержкой вызова инструментов (tool use) и генерирует структурированные ревью-комментарии с точностью до строки. Агент может читать полное содержимое файлов, искать по кодовой базе, заглядывать в другие изменённые файлы за контекстом и выполнять глубокое ревью — а не только давать поверхностные замечания по диффу. Помимо ревью диффов, `ocr scan` позволяет проверять файлы целиком — удобно для аудита незнакомой кодовой базы или каталогов без значимого диффа.
 
 ![Highlights](imgs/highlights-en.png)
 
@@ -227,6 +227,10 @@ ocr review --from main --to feature-branch
 
 # Один коммит
 ocr review --commit abc123
+
+# Полнофайловое сканирование — ревью целых файлов вместо диффа (история git не нужна)
+ocr scan                          # сканировать весь репозиторий
+ocr scan --path internal/agent    # сканировать каталог или конкретные файлы
 ```
 
 ### Интеграция с кодинг-агентами
@@ -338,7 +342,8 @@ ocr review \
 
 | Команда | Алиас | Описание |
 |---------|-------|----------|
-| `ocr review` | `ocr r` | Запустить код-ревью |
+| `ocr review` | `ocr r` | Запустить код-ревью на основе диффа |
+| `ocr scan` | `ocr s` | Ревью целых файлов (дифф не нужен) |
 | `ocr rules check <file>` | — | Показать, какое правило ревью применяется к пути файла |
 | `ocr config provider` | — | Интерактивная настройка провайдера (встроенный, пользовательский или ручной) |
 | `ocr config model` | — | Интерактивный выбор модели для активного провайдера |
@@ -357,6 +362,7 @@ ocr review \
 | `--from` | — | — | Исходный ref (например, `main`) |
 | `--to` | — | — | Целевой ref (например, `feature-branch`) |
 | `--commit` | `-c` | — | Один коммит для ревью |
+| `--exclude` | — | — | Паттерны в стиле gitignore через запятую для пропуска файлов; объединяются с excludes из rule.json |
 | `--preview` | `-p` | `false` | Показать, какие файлы попадут в ревью, без запуска LLM |
 | `--format` | `-f` | `text` | Формат вывода: `text` или `json` |
 | `--concurrency` | — | `8` | Максимум одновременных ревью файлов |
@@ -369,6 +375,27 @@ ocr review \
 | `--max-git-procs` | — | встроенное | Максимум одновременных git-подпроцессов |
 | `--tools` | — | — | Путь к пользовательскому JSON-конфигу инструментов |
 
+### Флаги `ocr scan`
+
+`ocr scan` проверяет целые файлы, а не дифф — удобно для аудита незнакомой кодовой базы, предмиграционного сканирования или любого каталога без значимого диффа. Работает и в каталогах без git (используется обход файловой системы с учётом `.gitignore`).
+
+| Флаг | Короткая форма | По умолчанию | Описание |
+|------|----------------|--------------|----------|
+| `--path` | — | весь репозиторий | Каталоги/файлы для сканирования через запятую |
+| `--exclude` | — | — | Паттерны в стиле gitignore через запятую для пропуска файлов; объединяются с excludes из rule.json |
+| `--preview` | `-p` | `false` | Показать список файлов для сканирования без запуска LLM |
+| `--max-tokens-budget` | — | `0` (без ограничений) | Ограничить суммарное потребление токенов; при превышении диспетчеризация прекращается |
+| `--no-plan` | — | `false` | Пропустить предварительное планирование по файлам |
+| `--no-dedup` | — | `false` | Пропустить дедупликацию похожих комментариев в рамках батча |
+| `--no-summary` | — | `false` | Пропустить сводку на уровне проекта |
+| `--batch` | — | `by-language` | Стратегия батчинга: `none`, `by-language` или `by-directory` |
+| `--format` | `-f` | `text` | Формат вывода: `text` или `json` (JSON включает поле `project_summary`) |
+| `--concurrency` | — | `8` | Максимум одновременных сканирований файлов |
+| `--rule` | — | — | Путь к пользовательским JSON-правилам ревью |
+| `--repo` | — | текущий каталог | Корень репозитория или каталога для сканирования |
+
+Перед каждым запуском `ocr scan` выводит приблизительную оценку стоимости в токенах. Используйте `--preview`, чтобы сначала посмотреть список файлов, и `--max-tokens-budget`, чтобы ограничить расход на больших репозиториях.
+
 ## Примеры
 
 ```bash
@@ -407,6 +434,21 @@ ocr review --rule /path/to/my-rules.json
 ocr rules check src/main/java/com/example/Foo.java
 ocr rules check --rule custom.json src/main/resources/mapper/UserMapper.xml
 
+# Полнофайловое сканирование: сначала просмотреть список файлов (без вызовов LLM)
+ocr scan --preview
+
+# Сканировать весь репозиторий, ограничив расход ~500k токенов
+ocr scan --max-tokens-budget 500000
+
+# Сканировать подкаталог, пропустив сгенерированные/тестовые файлы
+ocr scan --path internal --exclude '**/*_test.go,**/generated/**'
+
+# Сканировать каталог без git с JSON-выводом (включает project_summary)
+ocr scan --repo /path/to/plain/dir --format json
+
+# Самое быстрое сканирование: пропустить планирование, дедупликацию и сводку проекта
+ocr scan --no-plan --no-dedup --no-summary
+
 # Открыть историю сессий ревью в браузере
 ocr viewer
 ocr viewer --addr :3000

package/README.zh-CN.md

@@ -35,7 +35,7 @@
 
 Open Code Review 是一款 AI 驱动的代码审查 CLI 工具。它的前身是阿里集团内部官方 AI 代码审查助手，过去两年在内部服务了数万开发者，识别了数百万个代码缺陷。经过大规模充分验证后，我们将其孵化为开源项目，对社区开放。只需配置一个模型端点即可使用。
 
-它读取 Git diff，通过具备工具调用能力的 Agent 将变更文件发送至可配置的 LLM，生成具有行级精度的结构化审查意见。Agent 可以读取完整文件内容、搜索代码库、检查其他变更文件以获取上下文，从而进行深度审查——而非仅停留在表面的 diff 反馈。
+它读取 Git diff，通过具备工具调用能力的 Agent 将变更文件发送至可配置的 LLM，生成具有行级精度的结构化审查意见。Agent 可以读取完整文件内容、搜索代码库、检查其他变更文件以获取上下文，从而进行深度审查——而非仅停留在表面的 diff 反馈。除了 diff 审查，`ocr scan` 可以审查整个文件，适用于审计不熟悉的代码库或没有有意义 diff 的目录。
 
 ![Highlights](imgs/highlights-zh.png)
 
@@ -227,6 +227,10 @@ ocr review --from main --to feature-branch
 
 # 单个提交
 ocr review --commit abc123
+
+# 全量文件扫描 —— 审查整个文件而非 diff（无需 git 历史）
+ocr scan                          # 扫描整个仓库
+ocr scan --path internal/agent    # 扫描指定目录或文件
 ```
 
 ### 集成到编程 Agent
@@ -336,7 +340,8 @@ ocr review \
 
 | 命令 | 别名 | 描述 |
 |------|------|------|
-| `ocr review` | `ocr r` | 开始代码审查 |
+| `ocr review` | `ocr r` | 开始基于 diff 的代码审查 |
+| `ocr scan` | `ocr s` | 审查整个文件（无需 diff） |
 | `ocr rules check <file>` | — | 预览某个文件路径生效的审查规则 |
 | `ocr config provider` | — | 交互式供应商设置（内置、自定义或手动） |
 | `ocr config model` | — | 为当前供应商交互式选择模型 |
@@ -355,6 +360,7 @@ ocr review \
 | `--from` | — | — | 源引用（如 `main`） |
 | `--to` | — | — | 目标引用（如 `feature-branch`） |
 | `--commit` | `-c` | — | 审查单个提交 |
+| `--exclude` | — | — | 以逗号分隔的 gitignore 风格模式，用于跳过匹配文件；与 rule.json 中的 excludes 合并 |
 | `--preview` | `-p` | `false` | 预览将被审查的文件列表，不调用 LLM |
 | `--format` | `-f` | `text` | 输出格式：`text` 或 `json` |
 | `--concurrency` | — | `8` | 最大并发文件审查数 |
@@ -367,6 +373,27 @@ ocr review \
 | `--max-git-procs` | — | 内置默认 | 最大并发 git 子进程数 |
 | `--tools` | — | — | 自定义 JSON 工具配置路径 |
 
+### `ocr scan` 参数
+
+`ocr scan` 审查整个文件而非 diff —— 适用于审计不熟悉的代码库、迁移前扫描，或任何没有有意义 diff 的目录。它也可以在非 git 目录中工作（会回退到遵循 `.gitignore` 的文件系统遍历）。
+
+| 参数 | 缩写 | 默认值 | 描述 |
+|------|------|--------|------|
+| `--path` | — | 整个仓库 | 以逗号分隔的待扫描目录/文件 |
+| `--exclude` | — | — | 以逗号分隔的 gitignore 风格模式，用于跳过匹配文件；与 rule.json 中的 excludes 合并 |
+| `--preview` | `-p` | `false` | 列出将被扫描的文件，不运行 LLM |
+| `--max-tokens-budget` | — | `0`（无限制） | 限制总 token 使用量；超出后停止分发 |
+| `--no-plan` | — | `false` | 跳过按文件的规划预处理 |
+| `--no-dedup` | — | `false` | 跳过按批次的相似评论去重 |
+| `--no-summary` | — | `false` | 跳过项目级别的总结 |
+| `--batch` | — | `by-language` | 批处理策略：`none`、`by-language` 或 `by-directory` |
+| `--format` | `-f` | `text` | 输出格式：`text` 或 `json`（JSON 包含 `project_summary` 字段） |
+| `--concurrency` | — | `8` | 最大并发文件扫描数 |
+| `--rule` | — | — | 自定义 JSON 审查规则路径 |
+| `--repo` | — | 当前目录 | 要扫描的仓库或目录根路径 |
+
+每次运行前，`ocr scan` 会打印粗略的 token 费用估算。使用 `--preview` 先查看文件列表，使用 `--max-tokens-budget` 限制大型仓库的开销。
+
 ## 示例
 
 ```bash
@@ -405,6 +432,21 @@ ocr review --rule /path/to/my-rules.json
 ocr rules check src/main/java/com/example/Foo.java
 ocr rules check --rule custom.json src/main/resources/mapper/UserMapper.xml
 
+# 全量文件扫描：先预览文件列表（不调用 LLM）
+ocr scan --preview
+
+# 扫描整个仓库，限制消耗约 500k token
+ocr scan --max-tokens-budget 500000
+
+# 扫描子目录，跳过生成的/测试文件
+ocr scan --path internal --exclude '**/*_test.go,**/generated/**'
+
+# 扫描非 git 目录，使用 JSON 输出（包含 project_summary）
+ocr scan --repo /path/to/plain/dir --format json
+
+# 最快扫描：跳过规划、去重和项目总结
+ocr scan --no-plan --no-dedup --no-summary
+
 # 在浏览器中查看审查会话历史
 ocr viewer
 ocr viewer --addr :3000

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alibaba-group/open-code-review",
-  "version": "1.5.1",
+  "version": "1.6.1",
   "description": "OpenCodeReview CLI — AI-powered code review tool",
   "bin": {
     "ocr": "bin/ocr.js"
@@ -28,12 +28,12 @@
     "checksumPattern": "https://github.com/alibaba/open-code-review/releases/download/v{version}/sha256sum.txt"
   },
   "optionalDependencies": {
-    "@alibaba-group/ocr-darwin-arm64": "1.5.1",
-    "@alibaba-group/ocr-darwin-x64": "1.5.1",
-    "@alibaba-group/ocr-linux-arm64": "1.5.1",
-    "@alibaba-group/ocr-linux-x64": "1.5.1",
-    "@alibaba-group/ocr-win32-arm64": "1.5.1",
-    "@alibaba-group/ocr-win32-x64": "1.5.1"
+    "@alibaba-group/ocr-darwin-arm64": "1.6.1",
+    "@alibaba-group/ocr-darwin-x64": "1.6.1",
+    "@alibaba-group/ocr-linux-arm64": "1.6.1",
+    "@alibaba-group/ocr-linux-x64": "1.6.1",
+    "@alibaba-group/ocr-win32-arm64": "1.6.1",
+    "@alibaba-group/ocr-win32-x64": "1.6.1"
   },
   "engines": {
     "node": ">=14"