Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions cli-reference/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ rig login --token # paste a token at the prompt
rig login --import-token # read a token from stdin and validate it
```

Without a terminal, for example in a script, `rig login` stops and names what works instead: set `RIG_API_KEY` for each command (it isn't saved), or pipe the key to `rig login --import-token`, which validates and saves it. Only a key the server rejects is reported as invalid; if the server can't be reached, the error says so.

Signing in also sets up [SSH access](/guides/ssh-access) from this machine. Inside a workspace you don't sign in: the CLI there already acts as the workspace, and `rig login` and `rig logout` refuse.

Once logged in, any command works without further setup, for example:

```bash
Expand Down Expand Up @@ -57,9 +61,12 @@ To hit any endpoint directly without managing headers, use `rig api`. It reuses

```bash
rig api GET /v1/workspaces
rig api PATCH /v1/apps/APP_ID --body '{"name":"web"}'
rig api POST /v1/snapshots --body snapshot.json
```

`--body` takes inline JSON, a path to a JSON file, or `-` to read standard input; a body that isn't valid JSON fails before anything is sent. When the server returns an error, `rig api` prints the response body as the server sent it, reports the HTTP status, and exits non-zero. With `--output json`, the error event carries `status` and `body` alongside `code` and `message`. Inside a workspace, `rig api` sends requests through the workspace bridge, which serves only that workspace's routes.

## Bearer tokens (JWT)

If you authenticate through the dashboard login flow, you receive a short-lived JWT. The dashboard handles refresh automatically — for terminal use, prefer `rig login` (which manages the token for you) or an API key for non-interactive clients.
Expand Down
4 changes: 2 additions & 2 deletions cli-reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: Overview
description: Find Rigbox commands, flags, execution modes, and examples for Rigbox.
---

The `rig` and `rigbox` commands run the same CLI. This reference is generated from **v0.13.0-rc.2**.
The `rig` and `rigbox` commands run the same CLI. This reference is generated from CLI revision `1880d04`, which reports its version as **0.13.0-rc.4**.

Start with [installation](/guides/install-cli) and [authentication](/cli-reference/authentication). For a working application, follow the [quickstart](/quickstart).

Expand Down Expand Up @@ -48,7 +48,7 @@ Choose a command below, then follow its subcommand links. Each page includes its

## Source and coverage

The command tree comes from the CLI's Clap definitions at revision `09bd402`, including both local and workspace modes. Hidden internal commands and Clap's automatically generated `help` routing aliases are excluded; every documented command supports `--help`.
The command tree comes from the CLI's Clap definitions at revision `1880d04`, including both local and workspace modes. Inside a workspace, some commands parse but refuse with a one-line message saying where they work; their pages say so. Hidden internal commands and Clap's automatically generated `help` routing aliases are excluded; every documented command supports `--help`.

Syntax and flags are generated independently of maintained examples. Examples containing uppercase placeholders require your values. Commands that create, change, or delete resources perform those operations when run; `--help` is always offline.

Expand Down
150 changes: 93 additions & 57 deletions cli-reference/command-notes.json

Large diffs are not rendered by default.

8,877 changes: 7,129 additions & 1,748 deletions cli-reference/command-surface.json

Large diffs are not rendered by default.

55 changes: 52 additions & 3 deletions cli-reference/commands/ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ sidebarTitle: "ai"
description: "Configure account-level AI defaults and view usage"
---

Available **local**. Reference source: CLI `0.13.0-rc.2` (`09bd4024dd72`).
Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`).

Run this command on your local machine.
Run this command in an authenticated local terminal or inside a workspace; see the availability above.

## Examples

Expand Down Expand Up @@ -43,7 +43,7 @@ Configure account-level AI defaults and view usage
Usage: rigbox ai [OPTIONS] <COMMAND>

Commands:
defaults Update account-level AI defaults
defaults Show account-level AI defaults, or update them with any flag
usage Show AI usage history
help Print this message or the help of the given subcommand(s)

Expand Down Expand Up @@ -77,6 +77,55 @@ Options:

</Accordion>

## Workspace syntax

```text
Usage: rigbox ai [OPTIONS] <COMMAND>
```

### Arguments and flags

| Argument | Description | Details |
| --- | --- | --- |
| `--output` | Output format [default: human, or `rig config set output …`] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table |
| `--query` | Filter output with a JMESPath expression | Global; Value: JMESPATH |
| `--no-pager` | Do not pipe help output through a pager | Global; Default: false |
| `-v, --verbose` | Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status) | Global; Default: false |
| `-h, --help` | Print help | |

<Accordion title="Complete command help">

```text
Configure account-level AI defaults and view usage

Usage: rigbox ai [OPTIONS] <COMMAND>

Commands:
defaults Show account-level AI defaults, or update them with any flag
usage Show AI usage history
help Print this message or the help of the given subcommand(s)

Options:
--output <OUTPUT>
Output format [default: human, or `rig config set output …`]

[possible values: human, json, yaml, text, table]

--query <JMESPATH>
Filter output with a JMESPath expression

--no-pager
Do not pipe help output through a pager

-v, --verbose
Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)

-h, --help
Print help
```

</Accordion>

## Subcommands

- [defaults](/cli-reference/commands/ai/defaults)
Expand Down
74 changes: 69 additions & 5 deletions cli-reference/commands/ai/defaults.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,27 @@
---
title: "rig ai defaults"
sidebarTitle: "defaults"
description: "Update account-level AI defaults"
description: "Show account-level AI defaults, or update them with any flag"
---

Available **local**. Reference source: CLI `0.13.0-rc.2` (`09bd4024dd72`).
Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`).

Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.
With no flags, shows your account's default AI mode, provider, and model. Passing `--mode`, `--provider`, or `--model` changes only those fields. Inside a workspace the defaults can be read but not changed.

## Examples

Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.
Show the current defaults.

```bash
rig ai defaults
```

Change the default provider and model; the mode is left as it is.

```bash
rig ai defaults --provider anthropic --model claude-sonnet-4-20250514
```

Inspect the supported arguments before running this command. Help is offline and does not modify resources.

```bash
Expand Down Expand Up @@ -47,7 +53,7 @@ Usage: rigbox ai defaults [OPTIONS]
<Accordion title="Complete command help">

```text
Update account-level AI defaults
Show account-level AI defaults, or update them with any flag

Usage: rigbox ai defaults [OPTIONS]

Expand Down Expand Up @@ -91,3 +97,61 @@ Options:
```

</Accordion>

## Workspace syntax

```text
Usage: rigbox ai defaults [OPTIONS]
```

### Arguments and flags

| Argument | Description | Details |
| --- | --- | --- |
| `-p, --provider` | Default provider: google, openai, or anthropic | Value: PROVIDER |
| `-m, --model` | Default model id (e.g. claude-sonnet-4-20250514) | Value: MODEL |
| `--mode` | Default AI mode: managed or byok | Value: MODE; Choices: managed, byok |
| `--output` | Output format [default: human, or `rig config set output …`] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table |
| `--query` | Filter output with a JMESPath expression | Global; Value: JMESPATH |
| `--no-pager` | Do not pipe help output through a pager | Global; Default: false |
| `-v, --verbose` | Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status) | Global; Default: false |
| `-h, --help` | Print help | |

<Accordion title="Complete command help">

```text
Show account-level AI defaults, or update them with any flag

Usage: rigbox ai defaults [OPTIONS]

Options:
--output <OUTPUT>
Output format [default: human, or `rig config set output …`]

[possible values: human, json, yaml, text, table]

-p, --provider <PROVIDER>
Default provider: google, openai, or anthropic

-m, --model <MODEL>
Default model id (e.g. claude-sonnet-4-20250514)

--query <JMESPATH>
Filter output with a JMESPath expression

--mode <MODE>
Default AI mode: managed or byok

[possible values: managed, byok]

--no-pager
Do not pipe help output through a pager

-v, --verbose
Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)

-h, --help
Print help
```

</Accordion>
46 changes: 45 additions & 1 deletion cli-reference/commands/ai/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: "usage"
description: "Show AI usage history"
---

Available **local**. Reference source: CLI `0.13.0-rc.2` (`09bd4024dd72`).
Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`).

Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.

Expand Down Expand Up @@ -77,3 +77,47 @@ Options:
```

</Accordion>

## Workspace syntax

```text
Usage: rigbox ai usage [OPTIONS]
```

### Arguments and flags

| Argument | Description | Details |
| --- | --- | --- |
| `--output` | Output format [default: human, or `rig config set output …`] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table |
| `--query` | Filter output with a JMESPath expression | Global; Value: JMESPATH |
| `--no-pager` | Do not pipe help output through a pager | Global; Default: false |
| `-v, --verbose` | Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status) | Global; Default: false |
| `-h, --help` | Print help | |

<Accordion title="Complete command help">

```text
Show AI usage history

Usage: rigbox ai usage [OPTIONS]

Options:
--output <OUTPUT>
Output format [default: human, or `rig config set output …`]

[possible values: human, json, yaml, text, table]

--query <JMESPATH>
Filter output with a JMESPath expression

--no-pager
Do not pipe help output through a pager

-v, --verbose
Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)

-h, --help
Print help
```

</Accordion>
4 changes: 2 additions & 2 deletions cli-reference/commands/api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ sidebarTitle: "api-key"
description: "Manage account API keys"
---

Available **local**. Reference source: CLI `0.13.0-rc.2` (`09bd4024dd72`).
Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`).

Run this command on your local machine.
Run this command on your local machine. Inside a workspace, `rig api-key` refuses with a one-line message; run it from your laptop.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/api-key/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: "create"
description: "Create a new API key (plaintext is shown once)"
---

Available **local**. Reference source: CLI `0.13.0-rc.2` (`09bd4024dd72`).
Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`).

Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.

Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/api-key/ls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: "ls"
description: "List your API keys"
---

Available **local**. Reference source: CLI `0.13.0-rc.2` (`09bd4024dd72`).
Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`).

Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.

Expand Down
2 changes: 1 addition & 1 deletion cli-reference/commands/api-key/rm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: "rm"
description: "Revoke an API key"
---

Available **local**. Reference source: CLI `0.13.0-rc.2` (`09bd4024dd72`).
Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`).

Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.

Expand Down
Loading
Loading