コマンドチートシート

octoparse --help
octoparse --version
octoparse capabilities
octoparse doctor
octoparse doctor --chrome-path /path/to/chrome
octoparse browser doctor
octoparse browser doctor --chrome-path /path/to/chrome

octoparse capabilities --json
octoparse doctor --json
octoparse browser doctor --json

octoparse auth login              # OAuthまたはAPIキーを対話形式で選択
octoparse auth login --oauth      # ブラウザでOAuthログイン
octoparse auth login <apiKey>     # コピーしたAPIキーを検証して保存
octoparse auth login --stdin      # stdinからAPIキーを読み取る
octoparse auth login --no-open    # ブラウザを開かない
octoparse auth status
octoparse auth info
octoparse auth logout

OCTO_ENGINE_API_KEY=xxx octoparse task list --json
OCTO_ENGINE_ACCESS_TOKEN=xxx octoparse task list --json
OCTO_ENGINE_API_BASE_URL=https://example.com OCTO_ENGINE_API_KEY=xxx octoparse task list

octoparse task list
octoparse task list --page 2 --page-size 20
octoparse task list --limit 10
octoparse task list --keyword news
octoparse task inspect <taskId>
octoparse task validate <taskId>

octoparse task inspect <taskId> --task-file <file.json|file.xml|file.otd>
octoparse task validate <taskId> --task-file <file.json|file.xml|file.otd>

# 自動モード — CLIが最適な候補を選択してタスクファイルを生成
octoparse detect <url> --auto
octoparse detect <url> --auto --goal "商品タイトルと価格を抽出" --output task.json

# 手動モード — ブラウザで自分でデータ領域を選択するガイドフローを開く
octoparse detect <url> --manual
octoparse detect <url> --manual --goal "検索結果を取得"

# 検索してから検出 — エントリページでクエリを送信してから検出
octoparse detect <url> --auto --query "キーワード" --goal "検索結果を抽出"

octoparse run <taskId>
octoparse run <taskId> --headless
octoparse run <taskId> --max-rows 100
octoparse run <taskId> --detach
octoparse run <taskId> --output ./runs
octoparse run <taskId> --chrome-path /path/to/chrome
octoparse run <taskId> --task-file task.json

octoparse run <taskId> --timeout-ms 120000
octoparse run <taskId> --extension-timeout-ms 30000
octoparse run <taskId> --debug-bridge

octoparse run <taskId> --jsonl

octoparse cloud start <taskId>
octoparse cloud stop <taskId>
octoparse cloud status <taskId>
octoparse cloud history <taskId>

octoparse local status <taskId>
octoparse local pause <taskId>
octoparse local resume <taskId>
octoparse local stop <taskId>
octoparse local history <taskId>
octoparse local export <taskId> --format xlsx
octoparse local export <taskId> --format csv --file ./result.csv
octoparse local export <taskId> --lot-id <lotId> --format json
octoparse local cleanup

octoparse data history <taskId> --source local
octoparse data history <taskId> --source cloud
octoparse data export <taskId> --source local --format xlsx
octoparse data export <taskId> --source cloud --format csv
octoparse data export <taskId> --source local --format csv --file ./result.csv
octoparse data export <taskId> --source local --lot-id <lotId> --format json

octoparse run <taskId> --output ./runs
octoparse data history <taskId> --source local --output ./runs
octoparse data export <taskId> --source local --output ./runs --format xlsx

{
  "taskId": "abc123",
  "taskName": "Example",
  "xml": "... original OTD XML ...",
  "xoml": "... transformed BPMN XOML ...",
  "fieldNames": ["title", "url"],
  "workflowSetting": {},
  "brokerSettings": {},
  "userAgent": "Mozilla/5.0 ...",
  "disableAD": false
}