​

signup

orc signup creates a new Orchestor account in the browser and signs you in to the CLI. After you register, verify your email, and authorize the CLI, it saves the credentials and confirms they can be read back. You do not need to enter a password or email verification code in the terminal.

If you already have an account, use orc auth login. Run the command in an environment where you can use a browser. CLI sign-in, beta participation, and initial Workspace setup are separate states. Credentials are saved even if you have not joined the beta. After signing in, check your participation status with orc beta status, and apply an invitation code, if you have one, with orc beta redeem --stdin < beta-code.json.

Create a new account and sign in to the CLI.

When the Workspace is ready, use orc whoami to check the signed-in account. If the output indicates that initial setup is required, perform the next action shown.

With --json, --pretty, --ndjson, or --format json|pretty|ndjson, standard output contains the structured result. Normal progress messages and the confirmation code are not shown. If the browser cannot open automatically, run the command without these output options.

Output the authorization result as one JSON line

Type: boolean. Optional.

Check authentication and initial setup status as JSON.

Registration and authorization in the browser are still required. The credentials themselves are not printed. When authentication completes, data.authenticated is true. Use data.workspace_ready, data.onboarding_needed, data.first_read_succeeded, and data.next to check Workspace readiness and the next action. You can use the saved credentials for beta operations even when initial setup is required.

Inspect the planned actions without using the browser or API.

Prints an overview to standard error. Does not register an account, request authorization, or save credentials.

Press Ctrl+C to cancel. If registration is incomplete, run orc signup again. If the account is already registered, repeat authorization with orc auth login. A denied or expired authorization request does not complete sign-in. Follow the displayed instructions to retry sign-in.

If email verification succeeds but automatic sign-in fails, continue on the browser sign-in page. The return destination for CLI authorization is preserved.

The credentials have been saved. Check the status with orc beta status, and run orc beta redeem --stdin < beta-code.json if you have an invitation code. Workspace operations that require beta participation remain unavailable until you join.

Complete initial setup at /welcome in the browser. If next in the output shows orc open /welcome, use that command to open it. Completing sign-in does not by itself mean the Workspace is ready.

If saving or reading back credentials fails, the command does not report successful completion. Check the displayed error. New credentials are not saved when browser authorization is denied or the authentication response is invalid.

The following global options can be used with orc signup:

For details and examples, see global options.