> ## 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タスクを作成、実行、管理するためのOctoparse CLIです。

Octoparse CLIは、ターミナルからOctoparseタスクを作成、実行、管理、エクスポートするためのコマンドラインツールです。

デスクトップアプリとは異なり、Octoparse CLIはスクリプト化されたワークフロー、CI/CDパイプライン、サーバー環境、自動化されたデータパイプラインでの利用を想定しています。

## Octoparse CLIでできること

<CardGroup cols={2}>
  <Card title="URLからタスクを作成する" icon="wand-magic-sparkles" href="./cli/guides/detect">
    任意のURLを検査し、自動、手動、またはAIエージェントワークフローでローカルタスクファイルを生成します。
  </Card>

  <Card title="タスクを検索・管理する" icon="magnifying-glass" href="./cli/guides/tasks-and-groups">
    クラウドタスクを一覧表示し、キーワードで検索し、タスク詳細を確認できます。タスクグループでの管理にも対応しています。
  </Card>

  <Card title="テンプレートから作成する" icon="table-cells" href="./cli/guides/templates">
    テンプレートの閲覧と検索、テンプレートタスクの作成・変更ができます。
  </Card>

  <Card title="タスクをローカルで実行する" icon="play" href="./cli/guides/local-runs">
    組み込みのローカルエンジンと独立したChromeを使ってOctoparseタスクを実行できます。
  </Card>

  <Card title="ブラウザモードを選択する" icon="window" href="./cli/guides/browser-modes">
    独立Chromeまたはログイン済みChrome・Edgeプロファイルを使用します。
  </Card>

  <Card title="クラウド実行とスケジュール" icon="calendar" href="./cli/guides/cloud-runs-and-schedules">
    クラウド抽出の開始、履歴確認、定期スケジュール設定を行います。
  </Card>

  <Card title="データを確認・エクスポートする" icon="file-export" href="./cli/guides/data">
    レコード数の確認、行のプレビュー、未エクスポートデータの確認、ローカルまたはクラウドの結果のエクスポートができます。
  </Card>

  <Card title="エージェントで自動化する" icon="robot" href="./cli/guides/automation">
    JSON出力、JSONLイベントストリーム、終了コードを使ってCLIをスクリプトやAIエージェントに統合します。
  </Card>
</CardGroup>

## 仕組み

Octoparse CLIは、ローカル抽出のために組み込みのOctoparseエンジンを直接実行します。独立したChromeを使用し、Electronデスクトップクライアントは必要ありません。

クラウド抽出はバックエンドAPI経由で制御されます。ローカル抽出はローカルエンジンによって制御されます。

<Note>
  ローカル実行ステータスはこのCLIによって追跡され、Octoparseデスクトップクライアントのステータスとは同期されません。
</Note>

## 要件

Octoparse CLIを使用する前に、次のものを用意してください。

* Node.js 20以降
* npm 8以降
* Octoparseアカウント（APIキーまたはOAuth）
* 実行またはエクスポートしたいタスクへのアクセス権

詳しいバージョン要件、セットアップ手順、Linux arm64の制限については[インストール](./cli/quick-start/installation)を参照してください。

ローカルの `--task-file` や `.otd` の実行を含め、機能コマンドには認証が必要です。`--help`、`--version`、`doctor`、`browser`、`capabilities`、`auth` などのセットアップ・診断コマンドは、ログイン前でも実行できます。

## 基本ワークフロー

<Steps>
  <Step title="Octoparse CLIをインストールする">
    npmを使ってCLIをグローバルにインストールします。
  </Step>

  <Step title="認証する">
    OAuthまたはOctoparse APIキーでログインします。CIでは `OCTO_ENGINE_API_KEY` 環境変数を使用します。

    <Warning>
      APIキーをGit、スクリプト、ドキュメント、スクリーンショット、共有ログ、CI出力に含めないでください。
    </Warning>
  </Step>

  <Step title="タスクを作成または検索する">
    `octoparse detect <url>` でURLからタスクファイルを生成するか、`octoparse task list` で既存のタスクIDを検索します。
  </Step>

  <Step title="タスクを実行または制御する">
    タスクをローカルで実行する、クラウド実行を開始・停止する、または実行ステータスを確認します。
  </Step>

  <Step title="データをエクスポートする">
    ローカルまたはクラウドの結果から収集データをエクスポートします。
  </Step>
</Steps>

## クイックコマンド例

`<taskId>` は実際のタスクIDに、`<url>` はスクレイピングしたいページに置き換えてください。

```bash theme={null}
octoparse --help
octoparse doctor
octoparse auth login
octoparse detect <url> --auto --goal "商品タイトルと価格を抽出" --output task.json
octoparse task list
octoparse task inspect <taskId>
octoparse run <taskId>
octoparse cloud start <taskId>
octoparse local status <taskId>
octoparse data export <taskId> --source local --format xlsx
```

## 現在の制限

Octoparse CLI v1は、kernel browserまたはlegacy workflowをサポートしていません。

kernel browserは、古いOctoparseランタイムワークフローで使用されていたブラウザモードを指します。legacy workflowは、現在のCLIランタイムでサポートされていない古いOctoparseタスク定義で作成されたタスクを指します。

タスクがサポートされていない場合は、現在のOctoparseデスクトップアプリでタスクを再作成または更新し、その後CLIで再実行してください。

## 次のステップ

<CardGroup cols={3}>
  <Card title="Octoparse CLIをインストールする" icon="download" href="./cli/quick-start/installation">
    Node.jsをセットアップし、npmでCLIをインストールし、ローカルランタイムを確認します。
  </Card>

  <Card title="URLからタスクを作成する" icon="wand-magic-sparkles" href="./cli/guides/detect">
    detectを使って任意のURLからタスクファイルを生成します。
  </Card>

  <Card title="すべてのコマンドを見る" icon="list-check" href="./cli/reference/command-cheatsheet">
    タスク、テンプレート、スケジュール、detect、ローカル実行、クラウド実行、認証、エクスポート関連のコマンドを確認します。
  </Card>
</CardGroup>