Skip to content

docs(cli-reference): list the manifest status values in the status field #1587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lizhengfeng101 merged 2 commits into from
Sep 28, 2026
Merged

docs(cli-reference): list the manifest status values in the status field #1587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29113af
docs(cli-reference): list the manifest status values in the status field
ydflow Sep 28, 2026
2f82a00
docs: Apply batched suggestions from code review
lizhengfeng101 Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/src/content/docs/en/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ Top-level fields:

| Field | Notes |
|---|---|
| `status` | `success`, `completed_with_warnings`, `completed_with_errors`, or `skipped`. |
| `status` | When the output includes a `manifest` field, its terminal state: `complete`, `partial`, `failed`, or `skipped`. Otherwise: `success`, `completed_with_warnings`, or `completed_with_errors`. `skipped` also covers the no-supported-files case. |
| `llm` | Resolved LLM identity. The normalized `model` is always present; `provider` is present only for a named configured provider. |
| `message` | Optional. Human-readable summary, e.g. `"No comments generated. Looks good to me."`. |
| `summary` | Optional. Run aggregates: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens` (omitempty), `cache_write_tokens` (omitempty), `elapsed`. Omitted for `skipped` runs. |
Expand Down
2 changes: 1 addition & 1 deletion pages/src/content/docs/ja/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ ocr review --format json | jq .summary # stdout は単一の JSON ドキュメ

| フィールド | 説明 |
|---|---|
| `status` | `success`、`completed_with_warnings`、`completed_with_errors`、または `skipped`。 |
| `status` | 出力に `manifest` フィールドが含まれる場合はその終端状態（`complete`、`partial`、`failed`、`skipped`）。含まれない場合は `success`、`completed_with_warnings`、`completed_with_errors`。`skipped` はレビュー対象ファイルがない場合にも使われます。 |
| `llm` | 解決された LLM の識別情報。正規化済みの `model` は常に含まれ、`provider` は名前付きの設定済み provider の場合だけ含まれます。 |
| `message` | 任意。人間が読みやすいサマリー（例: `"No comments generated. Looks good to me."`）。 |
| `summary` | 任意。実行の集計: `files_reviewed`、`comments`、`total_tokens`、`input_tokens`、`output_tokens`、`cache_read_tokens`（omitempty）、`cache_write_tokens`（omitempty）、`elapsed`。`skipped` の実行時は省略されます。 |
Expand Down
2 changes: 1 addition & 1 deletion pages/src/content/docs/ko/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ ocr review --format json | jq .summary # stdout은 JSON 문서 하나입니다

| 필드 | 설명 |
|---|---|
| `status` | `success`, `completed_with_warnings`, `completed_with_errors`, `skipped` 중 하나입니다. |
| `status` | 출력에 `manifest` 필드가 있으면 그 터미널 상태입니다: `complete`, `partial`, `failed`, `skipped`. 없으면 `success`, `completed_with_warnings`, `completed_with_errors` 중 하나입니다. `skipped`는 리뷰할 파일이 없는 경우에도 사용됩니다. |
| `llm` | 해석된 LLM 정보입니다. 정규화한 `model`은 항상 있고, `provider`는 이름이 있는 설정된 프로바이더일 때만 나옵니다. |
| `message` | 선택. 사람이 읽는 요약입니다(예: `"No comments generated. Looks good to me."`). |
| `summary` | 선택. 실행 집계입니다: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens`(omitempty), `cache_write_tokens`(omitempty), `elapsed`. `skipped` 실행에서는 나오지 않습니다. |
Expand Down
2 changes: 1 addition & 1 deletion pages/src/content/docs/ru/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ ocr review --format json | jq .summary # stdout — единый JSON-доку

| Поле | Примечания |
|---|---|
| `status` | `success`, `completed_with_warnings`, `completed_with_errors` или `skipped`. |
| `status` | Если в выводе есть поле `manifest` — его терминальное состояние: `complete`, `partial`, `failed` или `skipped`. Иначе: `success`, `completed_with_warnings` или `completed_with_errors`. `skipped` также используется, когда нет файлов для ревью. |
| `message` | Необязательно. Сводка для чтения человеком, например, `"No comments generated. Looks good to me."`. |
| `summary` | Необязательно. Сводные показатели запуска: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens` (omitempty), `cache_write_tokens` (omitempty), `elapsed`. Отсутствует у запусков со статусом `skipped`. |
| `comments` | Присутствует всегда, но может быть пустым. Поля комментария показаны в примере выше. |
Expand Down
2 changes: 1 addition & 1 deletion pages/src/content/docs/zh/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ ocr review --format json | jq .summary # stdout 是单个 JSON 文档

| 字段 | 说明 |
|---|---|
| `status` | `success`、`completed_with_warnings`、`completed_with_errors` 或 `skipped`。 |
| `status` | 输出包含 `manifest` 字段时，为 manifest 的终态：`complete`、`partial`、`failed`、`skipped`；否则为 `success`、`completed_with_warnings`、`completed_with_errors`。`skipped` 也用于没有可评审文件的情况。 |
| `llm` | 实际解析的 LLM 标识。规范化后的 `model` 始终存在；`provider` 仅在使用已命名的配置 provider 时存在。 |
| `message` | 可选。人类可读摘要，如 `"No comments generated. Looks good to me."`。 |
| `summary` | 可选。运行聚合：`files_reviewed`、`comments`、`total_tokens`、`input_tokens`、`output_tokens`、`cache_read_tokens`（omitempty）、`cache_write_tokens`（omitempty）、`elapsed`。`skipped` 运行时省略。 |
Expand Down
Loading