Skip to main content
This page follows a typical extraction workflow: find a task, inspect it, run it, monitor it, and export the results.
v0.1.28 also adds task group workflows, template task workflows, cloud scheduling, and expanded data visibility. Exact commands for those new areas require confirmation from octoparse capabilities --json or v0.1.28 command help before using them in scripts.

​
List tasks

Query your task list:
Use pagination when needed:
Limit the number of returned tasks:
Search by keyword:
Use --json for machine-readable output:

​
Work with task groups

Task groups help organize related tasks and find the tasks that belong to a group.
Requires confirmation: exact v0.1.28 commands for listing task groups and viewing tasks within a group were not available in the local CLI 0.1.24 help.

​
Inspect a task

Use the task ID from the task list:
task inspect shows the task definition, field names, and related task metadata. Validate a task before running it:
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:
Run in headless mode:
Stop local extraction after saving a maximum number of rows:
Run in the background:
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:
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:
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:
Stop a local run:
View local run history:
Clean up local run state:
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:
Check cloud status:
View cloud history:
Stop a cloud run:

​
Configure cloud schedules

Cloud schedules are useful when a task should run on a recurring cadence, such as daily monitoring or weekly report collection.
Requires confirmation: exact v0.1.28 commands, schedule frequency values, timezone behavior, and limitations were not available in the local CLI 0.1.24 help.

​
Inspect and export data

Use data checks before export:
  • Count: check whether data exists and how many rows are available.
  • Preview: inspect sample rows before exporting.
  • Unexported: identify data not yet exported.
  • Export: retrieve full results.
Requires confirmation: exact v0.1.28 commands for count, preview, and unexported data were not available in the local CLI 0.1.24 help. Existing export commands are shown below.
Export local data as XLSX:
Export cloud data as CSV:
Export to a specific file:
If you used a custom output directory during local extraction, use the same --output value when reading local history or exporting local data:

​
What’s next

Create tasks from a URL

Use detect to generate a task file from any URL without the desktop app.

Browse all commands

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

Understand output and exit codes

Use JSON output, JSONL streams, and exit codes in scripts and automation.

Troubleshooting

Fix common errors: auth failures, Chrome issues, Linux arm64, and export problems.