> ## 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 コマンドリファレンス

> Octoparse CLIの認証、ブラウザ、タスク、テンプレート、実行、スケジュール、データコマンドの構文を確認します。

このページは構文の索引です。設定方法、動作、例、トラブルシューティングはリンク先のガイドを参照してください。

ほとんどの機能コマンドには認証が必要です。`<taskId>` などの山括弧は必須プレースホルダーです。

## コマンドグループ

| 目的        | コマンド                                | ガイド                                                 |
| --------- | ----------------------------------- | --------------------------------------------------- |
| インストールと認証 | `auth`, `doctor`                    | [認証](../quick-start/get-api-key-and-log-in)         |
| ブラウザを選択   | `browser`                           | [ブラウザモード](../guides/browser-modes)                  |
| タスクを管理    | `task`, `task-group`                | [タスクとグループ](../guides/tasks-and-groups)              |
| テンプレートを使用 | `template`, `template-task`         | [テンプレートを使用](../guides/templates)                    |
| URLから作成   | `detect`                            | [URLからタスクを作成](../guides/detect)                     |
| ローカルで実行   | `run`, `local`                      | [ローカル実行](../guides/local-runs)                      |
| クラウドで実行   | `cloud`, `schedule`                 | [クラウド実行とスケジュール](../guides/cloud-runs-and-schedules) |
| データを確認・出力 | `data`                              | [データとエクスポート](../guides/data)                        |
| 自動化       | `capabilities`, `--json`, `--jsonl` | [自動化とエージェント](../guides/automation)                  |

## ヘルプと診断

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

## 認証

```bash theme={null}
octoparse auth login
octoparse auth login --oauth
octoparse auth login <apiKey>
octoparse auth login --stdin
octoparse auth status --json
octoparse auth info --json
octoparse auth logout
```

## タスクとグループ

```bash theme={null}
octoparse task list [--page <n>] [--page-size <n>] [--limit <n>] [--keyword <text>] [--task-group <groupId>] [--template-id <id>] [--json]
octoparse task show <taskId> [--json]
octoparse task copy <taskId> [--task-group <groupId>] [--json]
octoparse task rename <taskId> --name <name> --yes [--json]
octoparse task move <taskId> --task-group <groupId> --yes [--json]
octoparse task delete <taskId> --yes [--json]
octoparse task inspect <taskId> [--task-file <file.json|file.xml|file.otd>] [--json]
octoparse task validate <taskId> [--task-file <file.json|file.xml|file.otd>] [--json]

octoparse task-group list [--json]
octoparse task-group create <name> [--json]
octoparse task-group update <groupId> --name <name> --yes [--json]
octoparse task-group delete <groupId> --yes [--json]
octoparse task-group set-default <groupId> --yes [--json]
```

## テンプレート

```bash theme={null}
octoparse template search <keyword> [--page <n>] [--page-size <n>] [--sort <n>] [--json]
octoparse template view <templateId> [--json]
octoparse template version <templateId> [--json]
octoparse template-task create <templateId> [--name <taskName>] [--task-group <groupId>] [--param key=value]... [--params <json>|--params-file <file>] [--dry-run] [--json]
octoparse template-task update <taskId> [--params <json>|--params-file <file>] --yes [--json]
```

## detectとブラウザ

```bash theme={null}
octoparse detect <url> --auto [--goal <text>] [--output task.json] [--json]
octoparse detect <url> --manual [--goal <text>] [--output task.json]
octoparse detect <url> --agent --agent-command <cmd> [--goal <text>] [--run-sample <n>] [--json]

octoparse browser use independent|user [--browser-id chrome|edge] [--profile <name>] [--json]
octoparse browser status [--browser-id chrome|edge] [--profile <name>] [--json]
octoparse browser profiles [--browser-id chrome|edge] [--json]
octoparse browser install [--browser-id chrome|edge] [--profile <name>] [--force-close] [--json]
```

## ローカル実行

```bash theme={null}
octoparse run <taskId> [--task-file <file>] [--output <dir>] [--max-rows <n>] [--detach] [--headless] [--json|--jsonl]
octoparse local status <taskId> [--output <dir>] [--json]
octoparse local pause <taskId> [--json]
octoparse local resume <taskId> [--json]
octoparse local stop <taskId> [--json]
octoparse local history <taskId> [--output <dir>] [--json]
octoparse local cleanup [--json]
```

## クラウド実行とスケジュール

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

octoparse schedule cloud get <taskId> [--json]
octoparse schedule cloud next --type <type> --date <value> --time <value> [--month <value>] [--json]
octoparse schedule cloud update <taskId> --type <type> --date <value> --time <value> [--month <value>] [--enabled true|false] --yes [--json]
octoparse schedule cloud start <taskId> --yes [--json]
octoparse schedule cloud stop <taskId> --yes [--json]
```

## データ

```bash theme={null}
octoparse data history <taskId> [--source local|cloud] [--output <dir>] [--json]
octoparse data count <taskId> [--source local|cloud] [--unexported] [--json]
octoparse data preview <taskId> [--source local|cloud] [--limit <n>] [--offset <n>] [--unexported] [--json]
octoparse data export <taskId> [--source local|cloud] [--file <result.xlsx>] [--lot-id <lotId>] [--output <dir>] [--format xlsx|csv|html|json|xml] [--unexported] [--json]
```

## 内部コマンド

`env` と `runs` は内部サポートおよびアーティファクト確認用です。Octoparseサポートから案内がない限り、公開されているtask ID・lot ID・`local`・`data` のワークフローを使用してください。

<Tip>
  インストール済みバージョンの構文は `octoparse <command> --help`、自動化メタデータは `octoparse capabilities --json` で確認できます。
</Tip>