Skip to main content

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.

This page follows a typical extraction workflow: find a task, inspect it, run it, monitor it, and export the results.

​
List tasks

Query your task list: 
octoparse task list
Use pagination when needed: 
octoparse task list --page 2 --page-size 20
Limit the number of returned tasks: 
octoparse task list --limit 10
Search by keyword: 
octoparse task list --keyword news --page 1 --page-size 10
Use --json for machine-readable output: 
octoparse task list --json

​
Inspect a task

Use the task ID from the task list: 
octoparse task inspect <taskId>
task inspect shows the task definition, field names, and related task metadata. Validate a task before running it: 
octoparse task validate <taskId>
task validate checks whether the task is compatible with the current CLI runtime and can be executed locally. If validation fails, review the task definition, update the task in Octoparse, or contact Octoparse support.

​
Run a task locally

Run: 
octoparse run <taskId>
Run in headless mode: 
octoparse run <taskId> --headless
Stop local extraction after saving a maximum number of rows: 
octoparse run <taskId> --max-rows 100
Run in the background: 
octoparse run <taskId> --detach
After detaching, use octoparse local status, octoparse local pause, octoparse local resume, or octoparse local stop to manage the run. Write local run artifacts to a custom directory: 
octoparse run <taskId> --output ./runs
If you use --output, pass the same path to data history and data export later.

​
Check or control a local run

Check local run status: 
octoparse local status <taskId>
Local run status is tracked by this CLI only and is not synchronized with the Octoparse desktop client status. This applies to local runs only.
Pause and resume a local run: 
octoparse local pause <taskId>
octoparse local resume <taskId>
Stop a local run: 
octoparse local stop <taskId>
View local run history: 
octoparse local history <taskId>
Clean up local run state: 
octoparse local cleanup
octoparse local cleanup removes stale local run state and temporary files. It does not stop currently running tasks.

​
Start or check a cloud run

Start cloud extraction: 
octoparse cloud start <taskId>
Check cloud status: 
octoparse cloud status <taskId>
View cloud history: 
octoparse cloud history <taskId>
Stop a cloud run: 
octoparse cloud stop <taskId>

​
Export data

Export local data as XLSX: 
octoparse data export <taskId> --source local --format xlsx
Export cloud data as CSV: 
octoparse data export <taskId> --source cloud --format csv
Export to a specific file: 
octoparse data export <taskId> --source local --format csv --file ./result.csv
If you used a custom output directory during local extraction, use the same --output value when reading local history or exporting local data: 
octoparse run <taskId> --output ./runs
octoparse data history <taskId> --source local --output ./runs
octoparse data export <taskId> --source local --output ./runs --format xlsx

​
What’s next

Continue with these reference pages:

Browse all commands

Review task, local run, cloud run, authentication, and export commands.

Understand output and exit codes

Learn how to use JSON output, JSONL streams, stdout, stderr, and exit codes in automation.