Basics

init

orc init validates and saves credentials and checks Workspace connectivity. With --website, it generates observation configuration from a site, confirms it, and waits for the first batch to complete.

The first observation requires an existing account and Workspace access. It reuses saved browser authentication or an API key and does not create an account or Workspace. See CLI onboarding for the complete workflow.

Usage

terminal
printf '%s' "$ORCHESTOR_API_KEY" | orc init

Validate an API key from standard input and initialize the CLI.

Unique options

--website

Website to onboard (waits through confirmation and the first batch)

Type: string. Optional.

terminal
orc init --website <value>

--region

Observation region (API default: JP)

Type: string. Optional.

terminal
orc init --region <value>

--language

Observation language (API default: ja)

Type: string. Optional.

terminal
orc init --language <value>

--no-confirm

Stop after extraction to review and edit before confirmation

Type: boolean. Optional.

terminal
orc init --no-confirm

--api-key

API key (deprecated; pipe via standard input instead)

Type: string. Optional.

terminal
orc init --api-key <value>

Examples

Run from website setup through the first observation.

terminal
orc init --website https://example.com --workspace <workspace-id> --timeout 10m

Run from website setup through the first observation.

Stop after generation for review.

terminal
orc init --website https://example.com --workspace <workspace-id> --no-confirm

Stop after generation for review.

Observation configuration and waiting

--region and --language select the observation region and language. When omitted, the API defaults are JP and ja. Select the target with --workspace.

--website waits even without --wait. Set a limit such as 10m with --timeout; there is no default wait limit. --poll-interval defaults to 5s. --json returns structured results.

If connectivity fails after configuration was saved, the saved settings remain. Check the target and authentication before retrying.

After interruption or timeout, check the current state using the displayed setup or batch status commands. Use --no-confirm to edit before confirmation and continue with the stepwise first observation guide.

Global Options

The following global options can be used with orc init:

For details and examples, see global options.