メインコンテンツへスキップ
Octoparse CLIは、ターミナルからOctoparseタスクを実行、管理、エクスポートするためのコマンドラインツールです。 デスクトップアプリとは異なり、Octoparse CLIはスクリプト化されたワークフロー、CI/CDパイプライン、サーバー環境、自動化されたデータパイプラインでの利用を想定しています。

​
Octoparse CLI でできること

タスクを検索・確認する

クラウドタスクを一覧表示し、キーワードで検索し、タスクIDを使ってタスク詳細を確認できます。

タスクをローカルで実行する

組み込みのローカルエンジンと独立したChromeを使ってOctoparseタスクを実行できます。

タスク実行を制御する

クラウド抽出の開始・停止、ローカル実行の一時停止、再開、停止、クリーンアップができます。

データをエクスポートする

ローカルまたはクラウドのタスクデータをXLSX、CSV、HTML、JSON、XMLとしてエクスポートできます。

​
仕組み

Octoparse CLIは、ローカル抽出のために組み込みの Octoparseエンジンを直接実行します。独立したChromeを使用し、Electronデスクトップクライアントは必要ありません。 クラウド抽出はバックエンドAPI経由で制御されます。ローカル抽出はローカルエンジンによって制御されます。
ローカル実行ステータスはこのCLIによって追跡され、Octoparseデスクトップクライアントのステータスとは同期されません。

​
要件

Octoparse CLIを使用する前に、次のものを用意してください。
  • Node.js 20 以降
  • npm 8 以降
  • 有効な Octoparse APIキー
  • 実行またはエクスポートしたいタスクへのアクセス権
詳しいバージョン要件とセットアップ手順はInstallationを参照してください。 ローカルの--task-fileや.otd実行を含め、機能コマンドには API キーが必要です。--help、--version、doctor、browser doctor、capabilities、authなどのセットアップ・診断コマンドは、ログイン前でも実行できます。

​
基本ワークフロー

1

Octoparse CLIをインストールする

npmを使ってCLIをグローバルにインストールします。
2

認証する

Octoparse APIキーでログインするか、環境変数でAPIキーを渡します。
APIキーをGit、スクリプト、ドキュメント、スクリーンショット、共有ログ、CI出力に含めないでください。
3

タスクを探す

octoparse task listを使ってタスクIDを確認します。
4

タスクを実行または制御する

タスクをローカルで実行する、クラウド実行を開始・停止する、または実行ステータスを確認します。
5

データをエクスポートする

ローカルまたはクラウドの結果から収集データをエクスポートします。

​
クイックコマンド例

<taskId>は実際のタスクIDに置き換えてください。タスクIDが必要な場合は、まずoctoparse task listを実行します。 
octoparse --help
octoparse doctor
octoparse auth login
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で再実行してください。

​
次のステップ

次のページに進んでください。

Octoparse CLIをインストールする

Node.jsをセットアップし、npmでCLIをインストールし、ローカルランタイムを確認します。

すべてのコマンドを見る

タスク、ローカル実行、クラウド実行、認証、エクスポート関連のコマンドを確認します。