メインコンテンツへスキップ

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は、ターミナル向けの人が読みやすい出力と、自動化向けの機械可読な出力をサポートしています。 スクリプト、エージェント、CIジョブ、その他の自動化環境からOctoparse CLIを呼び出す場合は、このページを参照してください。

​
JSON出力

安定した単一のJSONレスポンスが必要な場合は、--json を使用します。 
octoparse task list --json
octoparse auth status --json
octoparse local status <taskId> --json
成功したコマンドは、ok: true と data フィールドを持つJSONエンベロープを返します。 たとえば、octoparse task list --json は次のようなレスポンスを返す場合があります。 
{
  "ok": true,
  "data": {
    "items": [
      {
        "taskId": "abc123",
        "taskName": "Example task",
        "status": "Idle"
      }
    ],
    "page": 1,
    "pageSize": 20,
    "total": 1
  }
}
失敗したコマンドは、ok: false と error フィールドを持つJSONエンベロープを返します。 一般的なエラーレスポンスには、code と message が含まれます。 
{
  "ok": false,
  "error": {
    "code": "AUTH_REQUIRED",
    "message": "API key is required for this command."
  }
}
正確な data 構造はコマンドによって異なります。スクリプトを書く際は、対象コマンドの出力を信頼できる情報源として扱ってください。

​
JSONLイベントストリーム

長時間実行されるローカル実行イベントには、--jsonl を使用します。 
octoparse run <taskId> --jsonl
JSONL出力は、1行につき1つのJSONオブジェクトをストリームします。実行状況を逐次処理するエージェント、スクリプト、ログプロセッサに便利です。 典型的なストリーム例： 
{"type":"run.started","taskId":"abc123","timestamp":"2026-01-01T10:00:00.000Z"}
{"type":"row.saved","taskId":"abc123","count":1}
{"type":"run.completed","taskId":"abc123","savedRows":1}
イベント名やフィールドはバージョンによって変わる可能性があります。各行を1つのJSONオブジェクトとして扱い、未知のフィールドは安全に処理してください。

​
stdoutとstderr

human mode では：
StreamPurpose
stdout要求されたデータまたはコマンド出力
stderr診断、警告、失敗
--json および --jsonl モードでは、構造化出力はstdoutに書き込まれます。エラーは、コマンドと失敗の種類に応じて、stderrにプレーンテキストとして書き込まれるか、JSONエラーエンベロープとして返されます。 この分離により、自動化ツールは診断ログと混ざることなく、必要な出力をパイプできます。

​
終了コード

Exit codeMeaningTypical triggers
0成功コマンドが要求どおり完了
1操作失敗認証失敗、タスクが見つからない、エクスポートエラー
2ランタイムまたは環境の失敗Node.jsのバージョン不一致、Chromeが利用不可、エンジン初期化失敗
3サポートされていないタスク定義CLI v1でサポートされていないkernel browserまたはlegacy workflowをタスクが使用
ゼロ以外の終了コードは、コマンドが要求どおりに完了しなかったことを意味します。

​
自動化の推奨事項

  • 単一の構造化レスポンスが必要なスクリプトには --json を使用します。
  • 長時間実行されるタスクには --jsonl を使用します。
  • ゼロ以外の終了コードは、自動化ステップの失敗として扱います。
  • デバッグ時はstderrを別途取得します。
  • APIキーをログに出力しないでください。
AIエージェントや自動化環境では、人間向け出力よりも --json または --jsonl の使用を推奨します。