diff --git a/pages/src/content/docs/en/cli-reference.md b/pages/src/content/docs/en/cli-reference.md index 8bb479b2..92bce8ae 100644 --- a/pages/src/content/docs/en/cli-reference.md +++ b/pages/src/content/docs/en/cli-reference.md @@ -297,6 +297,36 @@ Non-fatal warnings (a single sub-agent failed, a file exceeded the token threshold, etc.) are printed inline; in JSON mode they're added to the `warnings` array. +## `ocr scan` + +Full-file review without a Git diff. Each file's current content is read +from the working tree and sent to the LLM — useful for auditing an +unfamiliar codebase or a directory with no meaningful diff. + +```text +ocr scan [flags] +ocr s [flags] (alias) +``` + +With no `--path`, the whole repository is scanned. + +### Flags + +| Flag | Short | Default | Description | +|---|---|---|---| +| `--path ` | - | whole repo | Comma-separated repo-relative directories or files to scan (e.g., `internal/agent`, `internal/llm/client.go`). | +| `--exclude ` | - | - | Comma-separated gitignore-style patterns to skip (e.g., `**/generated/*,*.pb.go`); merged with `rule.json` excludes. | +| `--preview` | `-p` | `false` | Enumerate and filter files without calling the LLM. Prints the file list, reviewable/excluded counts, total lines, and per-file exclusion reasons. | + +```bash +ocr scan --preview # see what would be scanned +ocr scan --path internal/agent # scan one directory +ocr scan --path internal/agent,internal/llm/client.go +ocr scan --exclude '**/generated/*,*.pb.go' +``` + +See `ocr scan -h` for the full flag list. + ## `ocr session` Lists and inspects local review session logs saved under diff --git a/pages/src/content/docs/ja/cli-reference.md b/pages/src/content/docs/ja/cli-reference.md index 1edfb34f..652ffc8e 100644 --- a/pages/src/content/docs/ja/cli-reference.md +++ b/pages/src/content/docs/ja/cli-reference.md @@ -275,6 +275,34 @@ ocr review --format json --audience agent 致命的でない警告(個々のサブエージェントの失敗、あるファイルが token しきい値を超過、など)はインラインで出力されます。JSON モードでは `warnings` 配列に追加されます。 +## `ocr scan` + +Git diff を必要としないファイル全体のレビュー。作業ツリーから各ファイルの現在の内容を読み込み、LLM に送信します。馴染みのないコードベースや、意味のある diff がないディレクトリの監査に便利です。 + +```text +ocr scan [flags] +ocr s [flags] (alias) +``` + +`--path` を渡さない場合、リポジトリ全体をスキャンします。 + +### 引数 + +| 引数 | 短縮形 | デフォルト | 説明 | +|---|---|---|---| +| `--path ` | - | リポジトリ全体 | スキャン対象のリポジトリ相対ディレクトリまたはファイル(カンマ区切り、例: `internal/agent`、`internal/llm/client.go`)。 | +| `--exclude ` | - | - | 除外する gitignore 形式のパターン(カンマ区切り、例: `**/generated/*,*.pb.go`)。`rule.json` の excludes とマージされます。 | +| `--preview` | `-p` | `false` | LLM を呼び出さずにファイルを列挙・フィルタリングします。ファイルリスト、レビュー対象/除外数、総行数、ファイルごとの除外理由を出力します。 | + +```bash +ocr scan --preview # スキャン対象を確認 +ocr scan --path internal/agent # 単一ディレクトリをスキャン +ocr scan --path internal/agent,internal/llm/client.go +ocr scan --exclude '**/generated/*,*.pb.go' +``` + +完全なフラグリストは `ocr scan -h` を参照してください。 + ## `ocr session` `~/.opencodereview/sessions/` 配下に保存されたローカルレビューセッションログを一覧表示・確認します。 diff --git a/pages/src/content/docs/ru/cli-reference.md b/pages/src/content/docs/ru/cli-reference.md index 82cc5cac..a8b71d63 100644 --- a/pages/src/content/docs/ru/cli-reference.md +++ b/pages/src/content/docs/ru/cli-reference.md @@ -273,6 +273,34 @@ ocr review --format json --audience agent порогового числа токенов файлом и т. п.) выводятся в процессе работы; в режиме JSON они добавляются в массив `warnings`. +## `ocr scan` + +Проверка файла целиком без Git diff. Текущее содержимое каждого файла считывается из рабочего дерева и отправляется в LLM. Удобно для аудита незнакомой кодовой базы или каталога без значимого diff. + +```text +ocr scan [flags] +ocr s [flags] (alias) +``` + +Если `--path` не задан, сканируется весь репозиторий. + +### Флаги + +| Флаг | Краткая форма | По умолчанию | Описание | +|---|---|---|---| +| `--path ` | - | весь репозиторий | Относительные каталоги или файлы репозитория для сканирования (через запятую, например `internal/agent`, `internal/llm/client.go`). | +| `--exclude ` | - | - | Шаблоны исключения в стиле gitignore (через запятую, например `**/generated/*,*.pb.go`); объединяются с excludes из `rule.json`. | +| `--preview` | `-p` | `false` | Перечисляет и фильтрует файлы без вызова LLM. Выводит список файлов, количество проверяемых/исключённых, общее число строк и причины исключения для каждого файла. | + +```bash +ocr scan --preview # посмотреть, что будет просканировано +ocr scan --path internal/agent # сканировать один каталог +ocr scan --path internal/agent,internal/llm/client.go +ocr scan --exclude '**/generated/*,*.pb.go' +``` + +Полный список флагов см. в `ocr scan -h`. + ## `ocr session` Выводит список и содержимое локальных журналов сессий ревью, сохранённых в diff --git a/pages/src/content/docs/zh/cli-reference.md b/pages/src/content/docs/zh/cli-reference.md index 29955d7f..82a6acdf 100644 --- a/pages/src/content/docs/zh/cli-reference.md +++ b/pages/src/content/docs/zh/cli-reference.md @@ -283,6 +283,35 @@ ocr review --format json --audience agent 非致命警告(单个子 agent 失败、某文件超过 token 阈值等)内联打印;JSON 模式下 会加入 `warnings` 数组。 +## `ocr scan` + +无需 Git diff 的全文件扫描。直接从工作树读取每个文件的当前内容交给 +LLM 评审——适合审计陌生代码库或没有有意义 diff 的目录。 + +```text +ocr scan [flags] +ocr s [flags] (alias) +``` + +不传入 `--path` 时,扫描整个仓库。 + +### 参数 + +| 参数 | 简写 | 默认 | 说明 | +|---|---|---|---| +| `--path ` | - | 整个仓库 | 逗号分隔的仓库相对目录或文件(如 `internal/agent`、`internal/llm/client.go`)。 | +| `--exclude ` | - | - | 逗号分隔的 gitignore 风格排除模式(如 `**/generated/*,*.pb.go`);与 `rule.json` 的 excludes 合并。 | +| `--preview` | `-p` | `false` | 枚举并过滤文件但跳过 LLM。打印文件列表、可评审/排除数量、总行数及每个文件的排除原因。 | + +```bash +ocr scan --preview # 查看会扫描哪些文件 +ocr scan --path internal/agent # 扫描单个目录 +ocr scan --path internal/agent,internal/llm/client.go +ocr scan --exclude '**/generated/*,*.pb.go' +``` + +完整参数列表见 `ocr scan -h`。 + ## `ocr session` 列出和查看保存在 `~/.opencodereview/sessions/` 下的本地评审会话日志。