Getting started

beta

orc beta checks beta access for the signed-in account and redeems invitation codes. status returns access eligibility and the account’s email address. redeem applies a code from standard input, then reads the access status again.

First sign in to your own account with orc auth login. To create an account, use orc signup. CLI credentials are saved before beta access and Workspace setup are complete, so you can run this command even when access has been denied. It operates on your own account; Workspace API keys and delegated Agent credentials cannot redeem invitation codes.

Usage

terminal
orc beta status

Check beta access for the signed-in account.

How it works

  1. Use your saved personal CLI credentials to identify the account. Beta access is not a prerequisite for this identity check.
  2. status retrieves current access status. redeem sends the JSON code to the server and attempts to grant access.
  3. After successful redemption, redeem retrieves access status again. If this read fails after a successful response, check the current status with orc beta status.

Status checks and redemptions operate at account level. Switching Workspaces does not apply a code to a different account.

Subcommands

status

Return betaAccess and email for the current account. betaAccess: true means access has been granted; false means the account has no access grant. Expiration is not included in the response. Accounts without access can also check their status.

terminal
orc beta status [options]

Examples

terminal
orc beta status --json

Check access status as JSON.

redeem

Set code in the JSON read through --stdin to the invitation code. After successful redemption, read status again and return the current access status. Resending to an account that already has access does not consume another use of an invitation code. Passing the code directly as an argument is unsupported.

terminal
orc beta redeem [options]

Examples

terminal
orc beta redeem --stdin < beta-code.json

Apply the code in an input file to your own account.

Examples

Invitation code input

The required code is a non-empty string. --stdin reads the JSON body and reports missing required fields before sending.

beta-code.json
{
  "code": "<invitation-code>"
}

Invitation code input

Store the input file where only you can read it. You do not need to paste the invitation code into shell arguments or history.

Redeem an invitation code

Read access status again after redemption and output a JSON envelope. Check data.betaAccess and data.email for access status and the target account.

terminal
orc beta redeem --stdin < beta-code.json --json

Redeem an invitation code

Preview the request

Display the planned request with the invitation code redacted. No request is sent, and code usage and access status are unchanged. Code validity and participant capacity are checked when the request reaches the server.

terminal
orc beta redeem --stdin < beta-code.json --dry-run

Preview the request

Troubleshooting

Authentication fails

Sign in again as yourself with orc auth login. If an API key is set through an environment variable, remove that setting to use your saved personal credentials. If you are signed in but betaAccess is false, redeem an invitation code.

An invitation code is rejected

code_unavailable means the code cannot be used. The response does not distinguish individual causes such as revocation, usage limits, or use by another account. Check the input and obtain another code if needed. capacity_reached indicates the beta participant limit; subject_not_found indicates that the account could not be found. For capacity limits, check the participation guidance again later. For account problems, sign in again.

state_conflict requires checking the code’s administrative state. Contact the operator before repeating the same input.

Processing fails after redemption

If Workspace setup fails, workspace_bootstrap_failed may be returned after access has been granted. First check access with orc beta status. Do the same for network errors or failed status readbacks. Resending to an account with access does not consume another code use.

Global Options

The following global options can be used with orc beta:

For details and examples, see global options.

  • orc signup: Create an account and authorize the CLI.
  • orc auth login: Sign in to the CLI with an existing account.
  • Global options: Shared JSON output, standard input, and dry-run behavior.