<taskId> indicate required placeholders.
Command families
| Goal | Commands | Guide |
|---|---|---|
| Install and authenticate | auth, doctor | Authentication |
| Choose a browser | browser | Browser modes |
| Manage tasks | task, task-group | Tasks and groups |
| Use templates | template, template-task | Use templates |
| Create from a URL | detect | Create tasks from a URL |
| Run locally | run, local | Local runs |
| Run in the cloud | cloud, schedule | Cloud runs and schedules |
| Inspect and export data | data | Data and export |
| Automate | capabilities, --json, --jsonl | Automation and agents |
Help and diagnostics
octoparse --help
octoparse --version
octoparse capabilities --json
octoparse doctor --json
octoparse browser status --json
Authentication
octoparse auth login
octoparse auth login --oauth
octoparse auth login <apiKey>
octoparse auth login --stdin
octoparse auth status --json
octoparse auth info --json
octoparse auth logout
Tasks and groups
octoparse task list [--page <n>] [--page-size <n>] [--limit <n>] [--keyword <text>] [--task-group <groupId>] [--template-id <id>] [--json]
octoparse task show <taskId> [--json]
octoparse task copy <taskId> [--task-group <groupId>] [--json]
octoparse task rename <taskId> --name <name> --yes [--json]
octoparse task move <taskId> --task-group <groupId> --yes [--json]
octoparse task delete <taskId> --yes [--json]
octoparse task inspect <taskId> [--task-file <file.json|file.xml|file.otd>] [--json]
octoparse task validate <taskId> [--task-file <file.json|file.xml|file.otd>] [--json]
octoparse task-group list [--json]
octoparse task-group create <name> [--json]
octoparse task-group update <groupId> --name <name> --yes [--json]
octoparse task-group delete <groupId> --yes [--json]
octoparse task-group set-default <groupId> --yes [--json]
Templates
octoparse template search <keyword> [--page <n>] [--page-size <n>] [--sort <n>] [--json]
octoparse template view <templateId> [--json]
octoparse template version <templateId> [--json]
octoparse template-task create <templateId> [--name <taskName>] [--task-group <groupId>] [--param key=value]... [--params <json>|--params-file <file>] [--dry-run] [--json]
octoparse template-task update <taskId> [--params <json>|--params-file <file>] --yes [--json]
Detect and browser
octoparse detect <url> --auto [--goal <text>] [--output task.json] [--json]
octoparse detect <url> --manual [--goal <text>] [--output task.json]
octoparse detect <url> --agent --agent-command <cmd> [--goal <text>] [--run-sample <n>] [--json]
octoparse browser use independent|user [--browser-id chrome|edge] [--profile <name>] [--json]
octoparse browser status [--browser-id chrome|edge] [--profile <name>] [--json]
octoparse browser profiles [--browser-id chrome|edge] [--json]
octoparse browser install [--browser-id chrome|edge] [--profile <name>] [--force-close] [--json]
Local runs
octoparse run <taskId> [--task-file <file>] [--output <dir>] [--max-rows <n>] [--detach] [--headless] [--json|--jsonl]
octoparse local status <taskId> [--output <dir>] [--json]
octoparse local pause <taskId> [--json]
octoparse local resume <taskId> [--json]
octoparse local stop <taskId> [--json]
octoparse local history <taskId> [--output <dir>] [--json]
octoparse local cleanup [--json]
Cloud runs and schedules
octoparse cloud start <taskId> [--json]
octoparse cloud stop <taskId> [--json]
octoparse cloud status <taskId> [--json]
octoparse cloud history <taskId> [--json]
octoparse schedule cloud get <taskId> [--json]
octoparse schedule cloud next --type <type> --date <value> --time <value> [--month <value>] [--json]
octoparse schedule cloud update <taskId> --type <type> --date <value> --time <value> [--month <value>] [--enabled true|false] --yes [--json]
octoparse schedule cloud start <taskId> --yes [--json]
octoparse schedule cloud stop <taskId> --yes [--json]
Data
octoparse data history <taskId> [--source local|cloud] [--output <dir>] [--json]
octoparse data count <taskId> [--source local|cloud] [--unexported] [--json]
octoparse data preview <taskId> [--source local|cloud] [--limit <n>] [--offset <n>] [--unexported] [--json]
octoparse data export <taskId> [--source local|cloud] [--file <result.xlsx>] [--lot-id <lotId>] [--output <dir>] [--format xlsx|csv|html|json|xml] [--unexported] [--json]
Internal commands
env and runs are internal support and artifact-inspection commands. Prefer the public task-ID, lot-ID, local, and data workflows unless Octoparse support instructs you otherwise.
Run
octoparse <command> --help for the installed version, and use octoparse capabilities --json for automation metadata.