Skip to main content

Sign in

Run orchestral login on your computer and finish sign-in in the browser. The CLI saves credentials for later commands. Confirm the active account with:
your computer
For automation, an organization administrator can create an API key and share it through the team’s approved secret manager. Save the key locally with orchestral login --api-key <KEY> or set it as ORC_API_KEY for an SDK client. Sign out with orchestral logout.

Roles

Every account has a role in its organization. orchestral whoami shows it:
Sample output
Roles come from your organization’s membership. Everyone in an organization can use all of its robots, so there is nothing to share robot by robot. Any role other than admin counts as a member.

Predict from your computer

A signed-in operator or authorized deployment owner can open a Python prediction session from their laptop. The session manages a temporary private network connection for its lifetime. Select the human login explicitly when the computer also has a robot credential:

Enroll a robot

Request enrollment on the robot computer. The command prints an eight-character approval code and waits for an organization administrator to approve it. It saves a local claim file so an interrupted or timed-out installation can resume before the enrollment expires. Use --no-wait to return immediately after creating the request.
robot computer
The command prints the code, how long it is valid, and the exact approve command (CODE below is the printed code). An organization administrator runs it from their own signed-in account:
You need to be an admin for your organization to run the approve command. orchestral whoami shows your role.
your computer
With the default wait behavior, the install completes after approval. If the command was interrupted or timed out, resume it with orchestral agent install --enrollment-code CODE; it waits for approval by default. Add --no-wait to return while approval is still pending. After approval, the command saves the robot credential to ~/.orchestral/robot-credentials.json and removes the pending claim file. Use one enrolled robot per computer. SDK sessions read the robot credential first, then fall back to the human login in ~/.orchestral/credentials.json. CLI management commands use the human login. Override these paths with ORC_ROBOT_CREDENTIALS_FILE, ORC_CREDENTIALS_FILE, and ORC_PENDING_ROBOT_ENROLLMENT_FILE. List and inspect enrolled robots with orchestral robots list and orchestral robots show robot-1. An administrator can remove a robot with orchestral robots remove robot-1; this revokes its installations while retaining its history.

Application keys

An organization administrator can create a key for an SDK application or robot service:
your computer
The secret is shown only once and is saved to the specified file. Keep it private. List key metadata with orchestral keys list and revoke a key with orchestral keys revoke <KEY_ID>.