> ## 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を自動化

> capabilities、JSON出力、環境変数認証、終了コードを使い、CI、スクリプト、AIエージェントからOctoparse CLIを操作します。

スクリプトやエージェントでは、人間向けヘルプの解析ではなく、機械可読出力とcapabilities検出を使用してください。

## 現在のコントラクトを取得する

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

レスポンスにはコマンド、認証、ブラウザモード、出力スキーマ、ライフサイクルイベント、推奨エージェントレシピが含まれます。

フラグやJSONフィールドを固定せず、ワークフロー開始時にコントラクトを確認してください。

## CIで認証する

```bash theme={null}
OCTO_ENGINE_API_KEY=xxx octoparse task list --json
OCTO_ENGINE_ACCESS_TOKEN=xxx octoparse task list --json
```

認証情報の優先順位はアクセストークン、APIキー、`octoparse auth login` で保存した認証情報です。

<Warning>
  認証情報を共有ログ、スクリーンショット、生成ドキュメントに出力したり、Gitへコミットしたりしないでください。
</Warning>

## 出力モードを選択する

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

* `--json` は1つの結果エンベロープを返します。
* `--jsonl` はフォアグラウンド実行イベントをJSON Linesでストリームします。
* 人間向け出力は対話型ターミナル用です。

スキーマ、イベント、stdout/stderr、終了コードは[出力と終了コード](../reference/output-and-exit-codes)を参照してください。

## エージェントでタスクを作成する

エージェントでは `--auto` ではなく、`detect --agent` または prepare / preview / apply ワークフローを使用します。

```bash theme={null}
octoparse detect <url> \
  --agent \
  --agent-command "path/to/trusted-agent" \
  --goal "商品タイトルと価格を抽出" \
  --run-sample 5 \
  --json
```

capabilitiesレスポンスの `machineContract.recipes.createTaskFromUrlWithAgent` に従い、`--agent-command` には信頼できる実行ファイルだけを指定してください。

## 状態変更コマンドを確認する

名前変更、移動、削除、更新、スケジュール変更には `--yes` が必要な場合があります。自動化を作る前に `capabilities --json` で確認要件を取得してください。

## 内部コマンド

`env` は内部API環境の切り替え、`runs` は内部ローカルアーティファクトの確認用です。Octoparseサポートから案内がない限り、公開されているtask ID・lot IDベースのコマンドを使用してください。