Skip to main content

​
Authentication requirements

Most Octoparse CLI commands require authentication. An API key or OAuth session identifies your account and authorizes access to your Octoparse tasks and data.
All functional commands require valid credentials, including local --task-file and .otd runs and template discovery commands. Authenticate before listing, searching templates, running, or exporting tasks.
Starting with CLI v0.1.33, template search, template view, and template version require credentials. CLI v0.1.32 allowed these commands to browse the same template catalog without logging in.
Only setup and diagnostic commands can run without credentials:

​
Login methods

Octoparse CLI supports two login methods: OAuth and API key.

​
OAuth (browser-based)

Open a browser login flow and store access and refresh tokens locally:
Use OAuth when you prefer not to manage API keys manually or when your team uses SSO.

​
API key

Create API keys in the Octoparse console:

Open API keys page

Create, copy, and manage Octoparse API keys from your account center.
Interactive login — opens the API key page, then prompts you to paste a key:
Pass the key directly — verifies and stores a copied key:
Avoid opening the browser:
Read the key from stdin — for secret managers and CI pipelines:
For example, with 1Password CLI:
The CLI verifies the API key before saving it. Invalid keys are not stored.

​
Use an environment variable

For CI or temporary sessions, provide credentials through environment variables instead of stored credentials:
For bearer token access (useful in short-lived CI jobs):
You can also override the API base URL:

​
Credential precedence

Octoparse CLI checks credentials in this order:
The credentials file is created automatically by octoparse auth login. On macOS and Linux:
On Windows:
Do not commit API keys or tokens to Git, scripts, docs, screenshots, shared logs, or CI output.

​
Check and manage auth status

Confirm your session is active:
Show detailed account and credential info:
Remove saved credentials:

​
What’s next

Run your first task

List tasks, inspect a task, run it locally, and export data.

Browse all commands

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