---
title: beta
description: Check beta access and redeem an invitation code.
canonical_url: https://orchestor.io/docs/en/cli/beta
markdown_url: https://orchestor.io/docs/en/cli/beta.md
contentType: reference
---

# 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`](https://orchestor.io/docs/cli/auth.md). To create an account, use [`orc signup`](https://orchestor.io/docs/cli/signup.md). 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

```bash title="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.

```bash title="terminal"
orc beta status [options]
```

#### Examples

```bash title="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.

```bash title="terminal"
orc beta redeem [options]
```

#### Examples

```bash title="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.

```json title="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.

```bash title="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.

```bash title="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`](https://orchestor.io/docs/cli/auth.md). 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](https://orchestor.io/docs/cli/global-flags.md) can be used with `orc beta`:

- [`--help`](https://orchestor.io/docs/cli/global-flags.md#help)
- [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#workspace)
- [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-output)
- [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-output)
- [`--format`](https://orchestor.io/docs/cli/global-flags.md#output-format)
- [`--field`](https://orchestor.io/docs/cli/global-flags.md#field-selection)
- [`--fields`](https://orchestor.io/docs/cli/global-flags.md#field-selection)
- [`--raw`](https://orchestor.io/docs/cli/global-flags.md#raw-output)
- [`--output`](https://orchestor.io/docs/cli/global-flags.md#file-output)
- [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#pager)
- [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#dry-run)
- [`--yes`](https://orchestor.io/docs/cli/global-flags.md#confirmation)
- [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input)
- [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input)
- [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#all-pages)
- [`--timing`](https://orchestor.io/docs/cli/global-flags.md#request-timing)

For details and examples, see [global options](https://orchestor.io/docs/cli/global-flags.md).

## Related

- [`orc signup`](https://orchestor.io/docs/cli/signup.md): Create an account and authorize the CLI.
- [`orc auth login`](https://orchestor.io/docs/cli/auth.md): Sign in to the CLI with an existing account.
- [Global options](https://orchestor.io/docs/cli/global-flags.md): Shared JSON output, standard input, and dry-run behavior.

---

[Documentation index](https://orchestor.io/docs/llms.txt)