Getting started

init

In CLI 0.5.0, init configures credentials and verifies connectivity. The --website observation flow below is available in the published native v0.6.30 release, but is not included in 0.5.0. Check your installed orc init --help. If unsupported, use the stepwise first observation guide.

This page is the command reference for @orchestor-inc/cli.

Commands

  • orc init — Validate an API key, resolve its Workspace, save config, and verify connectivity

orc init

Validate an API key, resolve its Workspace, save config, and verify connectivity

Usage

orc init [flags]

Flags

FlagTypeRequiredDescription
--api-keystringNoAPI key (deprecated; pipe via standard input instead)

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc init --help

First observation options in native v0.6.30

With --website, native v0.6.30 generates configuration candidates, confirms them, and waits for the first batch. It reuses your saved browser login or an API key. It does not create an account or workspace.

FlagTypeDescription
--websitestringWebsite URL used to generate candidates.
--regionstringObservation region; API default JP.
--languagestringObservation language; API default ja.
--no-confirmbooleanStop after generation so candidates can be reviewed.
--timeoutstringWait limit, such as 10m; no default limit.
--poll-intervalstringStatus polling interval; default 5s.

Use --workspace to select the target and --json for structured output. Follow the first observation guide for confirmation, result retrieval, and recovery.