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

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.

特に記載がない限り、ほとんどの機能コマンドには認証が必要です。機械可読な出力が必要な場合は、対応するコマンドで --json を使用してください。 <taskId> や <apiKey> のような山括弧は必須のプレースホルダーを示します。実際のタスクIDまたはAPIキーに置き換えてください。

​
ヘルプと診断

octoparse --help
octoparse --version
octoparse capabilities
octoparse doctor
octoparse browser doctor
構造化された診断情報が必要な場合は、JSON出力を使用します。 
octoparse capabilities --json
octoparse doctor --json
octoparse browser doctor --json

​
認証

octoparse auth login
octoparse auth login <apiKey>
octoparse auth login --stdin
octoparse auth login --no-open
octoparse auth status
octoparse auth logout
ログイン後に octoparse auth status を実行し、セッションが有効であることを確認します。

​
タスク

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>

​
ローカル抽出

octoparse run <taskId>
octoparse run <taskId> --headless
octoparse run <taskId> --max-rows 100
octoparse run <taskId> --detach
octoparse run <taskId> --output ./runs
ローカル実行をデタッチした後は、octoparse local status、octoparse local pause、octoparse local resume、octoparse local stop を使って管理します。
必要に応じてカスタムChromeパスを指定します。 
octoparse run <taskId> --chrome-path /path/to/chrome

​
クラウド抽出

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 cleanup
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
サポートされるエクスポート形式： 
xlsx
csv
html
json
xml

​
タスクファイル形式

タスクファイルには次の構造を使用できます。 
{
  "taskId": "abc123",
  "taskName": "Example",
  "xml": "... original OTD XML ...",
  "xoml": "... transformed BPMN XOML ...",
  "fieldNames": ["title", "url"],
  "workflowSetting": {},
  "brokerSettings": {},
  "userAgent": "Mozilla/5.0 ...",
  "disableAD": false
}
主なフィールド：
FieldMeaning
taskIdOctoparseタスクID
taskName人が読めるタスク名
xml元のOTD XML定義
xomlエンジンで使用される変換済みワークフロー定義
fieldNamesタスクから期待される出力フィールド名
workflowSettingタスクのワークフロー設定
brokerSettingsランタイムまたはブローカー関連のタスク設定
userAgent抽出時に使用されるブラウザのUser-Agent
disableAD広告ブロックを無効化するかどうか
ローカルの --task-file や .otd の実行を含め、機能コマンドにはAPIキー認証が必要です。