> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# コマンドチートシート

> Octoparse CLIのすべてのコマンドのクイックリファレンス。認証、タスク、ローカル・クラウド抽出、detect、データエクスポートを網羅します。

特に記載がない限り、ほとんどの機能コマンドには認証が必要です。機械可読な出力が必要な場合は、対応するコマンドで `--json` を使用してください。

`<taskId>` や `<apiKey>` のような山括弧は必須のプレースホルダーを示します。実際の値に置き換えてください。

## ヘルプと診断

```bash theme={null}
octoparse --help
octoparse --version
octoparse capabilities
octoparse doctor
octoparse doctor --chrome-path /path/to/chrome
octoparse browser doctor
octoparse browser doctor --chrome-path /path/to/chrome
```

構造化出力：

```bash theme={null}
octoparse capabilities --json
octoparse doctor --json
octoparse browser doctor --json
```

<Note>
  `capabilities --json` は、AIエージェントと自動化向けの完全なマシンコントラクトを返します。サポートされているコマンド、出力スキーマ、推奨タスク作成ワークフローが含まれます。
</Note>

<Warning>
  v0.1.28 では、一部の高リスクコマンドにはより強力な確認が必要です。コマンドによっては、明示的な確認フラグの指定や確認フレーズの入力が必要になる場合があります。正確な書式は `octoparse capabilities --json` または v0.1.28 のコマンドヘルプで確認してから、コピー＆ペースト用の例に記載してください。
</Warning>

## 認証

```bash theme={null}
octoparse auth login              # OAuthまたはAPIキーを対話形式で選択
octoparse auth login --oauth      # ブラウザでOAuthログイン
octoparse auth login <apiKey>     # コピーしたAPIキーを検証して保存
octoparse auth login --stdin      # stdinからAPIキーを読み取る
octoparse auth login --no-open    # ブラウザを開かない
octoparse auth status
octoparse auth info
octoparse auth logout
```

環境変数による上書き（認証情報の保存不要）：

```bash theme={null}
OCTO_ENGINE_API_KEY=xxx octoparse task list --json
OCTO_ENGINE_ACCESS_TOKEN=xxx octoparse task list --json
OCTO_ENGINE_API_BASE_URL=https://example.com OCTO_ENGINE_API_KEY=xxx octoparse task list
```

## タスク

```bash theme={null}
octoparse task list
octoparse task list --page 2 --page-size 20
octoparse task list --limit 10
octoparse task list --keyword news
octoparse task inspect <taskId>
octoparse task validate <taskId>
```

ローカルタスクファイルを使用する場合：

```bash theme={null}
octoparse task inspect <taskId> --task-file <file.json|file.xml|file.otd>
octoparse task validate <taskId> --task-file <file.json|file.xml|file.otd>
```

### タスクグループ

タスクグループを使うと、関連するタスクをまとめ、グループ内のタスクを探しやすくなります。

<Note>
  確認が必要：タスクグループの一覧表示やグループ内のタスク確認を行う正確な v0.1.28 コマンドは、ローカルCLI 0.1.24 のヘルプにはありませんでした。例を追加する前に `octoparse capabilities --json` または v0.1.28 のコマンドヘルプで確認してください。
</Note>

## Templates

v0.1.28 ではテンプレートワークフローが拡張され、テンプレートの閲覧と検索、テンプレートタスクの作成、テンプレートタスクの変更ができるようになりました。これらのワークフローでは「テンプレートタスク」または「テンプレートから作成したタスク」という表現を使用してください。CLI が任意のカスタムスクレイピングワークフローを作成するとは断定しないでください（CLI のコントラクトで確認されている場合を除く）。

<Note>
  確認が必要：テンプレートの閲覧、検索、テンプレートタスクの作成・変更を行う正確な v0.1.28 コマンドとフラグは、ローカルCLI 0.1.24 のヘルプにはありませんでした。例を追加する前に `octoparse capabilities --json` または v0.1.28 のコマンドヘルプで確認してください。
</Note>

## Detect（URLからタスクを作成）

`detect` はOctoparse拡張ブラウザを開き、ページを検査してタスクファイルを生成します。

```bash theme={null}
# 自動モード — CLIが最適な候補を選択してタスクファイルを生成
octoparse detect <url> --auto
octoparse detect <url> --auto --goal "商品タイトルと価格を抽出" --output task.json

# 手動モード — ブラウザで自分でデータ領域を選択するガイドフローを開く
octoparse detect <url> --manual
octoparse detect <url> --manual --goal "検索結果を取得"

# 検索してから検出 — エントリページでクエリを送信してから検出
octoparse detect <url> --auto --query "キーワード" --goal "検索結果を抽出"
```

AIエージェントワークフローには、prepare / preview / apply シーケンスまたは `--agent` ラッパーを使用します。詳細は[URLからタスクを作成する](../guides/detect)を参照してください。

## ローカル抽出

```bash theme={null}
octoparse run <taskId>
octoparse run <taskId> --headless
octoparse run <taskId> --max-rows 100
octoparse run <taskId> --detach
octoparse run <taskId> --output ./runs
octoparse run <taskId> --chrome-path /path/to/chrome
octoparse run <taskId> --task-file task.json
```

タイムアウトとデバッグオプション：

```bash theme={null}
octoparse run <taskId> --timeout-ms 120000
octoparse run <taskId> --extension-timeout-ms 30000
octoparse run <taskId> --debug-bridge
```

実行イベントを1行ずつストリームするには `--jsonl` を使用します。

```bash theme={null}
octoparse run <taskId> --jsonl
```

<Note>
  `--detach` でデタッチした後は、`octoparse local status`、`octoparse local pause`、`octoparse local resume`、`octoparse local stop` を使って実行を管理します。
</Note>

## クラウド抽出

```bash theme={null}
octoparse cloud start <taskId>
octoparse cloud stop <taskId>
octoparse cloud status <taskId>
octoparse cloud history <taskId>
```

## クラウドスケジュール

クラウドスケジュールは、毎日の価格監視、毎週のレポート収集、定期的なリード enrichment など、定期的に実行するクラウドタスクに便利です。

<Note>
  確認が必要：正確な v0.1.28 のスケジュールコマンドの書式、タイムゾーンの扱い、頻度の値、スケジュールの制限は、ローカルCLI 0.1.24 のヘルプにはありませんでした。例を追加する前に `octoparse capabilities --json` または v0.1.28 のコマンドヘルプで確認してください。
</Note>

## ローカル実行制御

```bash theme={null}
octoparse local status <taskId>
octoparse local pause <taskId>
octoparse local resume <taskId>
octoparse local stop <taskId>
octoparse local history <taskId>
octoparse local export <taskId> --format xlsx
octoparse local export <taskId> --format csv --file ./result.csv
octoparse local export <taskId> --lot-id <lotId> --format json
octoparse local cleanup
```

`octoparse local cleanup` は、古いローカル実行状態と一時ファイルを削除します。実行中のタスクは停止しません。

## データ履歴、プレビュー、エクスポート

```bash theme={null}
octoparse data history <taskId> --source local
octoparse data history <taskId> --source cloud
octoparse data export <taskId> --source local --format xlsx
octoparse data export <taskId> --source cloud --format csv
octoparse data export <taskId> --source local --format csv --file ./result.csv
octoparse data export <taskId> --source local --lot-id <lotId> --format json
```

サポートされるエクスポート形式：`xlsx`、`csv`、`html`、`json`、`xml`

用途に応じたデータコマンド：

| 用途                   | 使うコマンド                      |
| -------------------- | --------------------------- |
| データの存在と利用可能な行数を確認する  | レコード数（Record count）         |
| エクスポート前にサンプル行を確認する   | プレビュー（Preview data）         |
| まだエクスポートされていない行を特定する | 未エクスポートデータ（Unexported data） |
| 完全な結果を取得する           | エクスポート（Export data）         |

<Note>
  確認が必要：レコード数、プレビュー、未エクスポートデータの正確な v0.1.28 コマンドとフラグは、ローカルCLI 0.1.24 のヘルプにはありませんでした。例を追加する前に `octoparse capabilities --json` または v0.1.28 のコマンドヘルプで確認してください。
</Note>

ローカル抽出でカスタム出力ディレクトリを使用した場合は、履歴とエクスポートにも同じ `--output` パスを渡してください。

```bash theme={null}
octoparse run <taskId> --output ./runs
octoparse data history <taskId> --source local --output ./runs
octoparse data export <taskId> --source local --output ./runs --format xlsx
```

## タスクファイル形式

```json theme={null}
{
  "taskId": "abc123",
  "taskName": "Example",
  "xml": "... original OTD XML ...",
  "xoml": "... transformed BPMN XOML ...",
  "fieldNames": ["title", "url"],
  "workflowSetting": {},
  "brokerSettings": {},
  "userAgent": "Mozilla/5.0 ...",
  "disableAD": false
}
```

| フィールド             | 説明                       |
| ----------------- | ------------------------ |
| `taskId`          | OctoparseタスクID           |
| `taskName`        | 人が読めるタスク名                |
| `xml`             | 元のOTD XML定義              |
| `xoml`            | エンジンで使用される変換済みワークフロー定義   |
| `fieldNames`      | タスクから期待される出力フィールド名       |
| `workflowSetting` | タスクのワークフロー設定             |
| `brokerSettings`  | ランタイムまたはブローカー関連のタスク設定    |
| `userAgent`       | 抽出時に使用されるブラウザのUser-Agent |
| `disableAD`       | 広告ブロックを無効化するかどうか         |

<Note>
  ローカルの `--task-file` や `.otd` の実行を含め、機能コマンドにはAPIキー認証が必要です。
</Note>