Getting started

​
Install the CLI and read your first data

Use Node.js 24 or later and an account that can sign in through a browser. Check orc --version first in an existing installation.

For a new account, start with signup and invitation entry in the quickstart. Enter the invitation code provided by your contact in the web app to begin onboarding.

For an existing account, see Sign in from the CLI for detailed authentication steps.

​
Steps

npm install -g @orchestor-inc/cli@0.6.0
orc --version
orc --help
orc auth login
orc auth status --json
orc workspaces list --json
orc workspace current --json
orc brands list --workspace WORKSPACE_ID --json

Replace WORKSPACE_ID with the intended ID from the list. Verify sign-in, the selected workspace, and the brand request separately. An empty list without an HTTP error is a successful read. Authentication alone does not prove data access.

If the brand list is empty, run your first observation.

Workflow index · Setup reference

If a failure remains, report it and verify the fix, including this workflow and the failed step.