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
5 changes: 3 additions & 2 deletions cli-reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ 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 CLI revision `1880d04`, which reports its version as **0.13.0-rc.4**.
The `rig` and `rigbox` commands run the same CLI. This reference is generated from CLI revision `824aefd`, which reports its version as **0.13.0-rc.5**.

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

## Find a command

Choose a command below, then follow its subcommand links. Each page includes its execution mode, example invocations, arguments, flags, and complete help.

- [`rig account`](/cli-reference/commands/account)
- [`rig ai`](/cli-reference/commands/ai)
- [`rig api`](/cli-reference/commands/api)
- [`rig api-key`](/cli-reference/commands/api-key)
Expand Down Expand Up @@ -48,7 +49,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 `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`.
The command tree comes from the CLI's Clap definitions at v0.13.0-rc.5 (revision `824aefd`), 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
27 changes: 27 additions & 0 deletions cli-reference/command-notes.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
{
"account": {
"description": "Run this command on your local machine. It isn't available inside a workspace.",
"examples": [
{
"description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.",
"command": "rig account --help"
}
]
},
"account/delete": {
"description": "Use this command from your local terminal; it isn't available inside a workspace. `--dry-run` lists what would be deleted and changes nothing. Without a terminal, `--confirm EMAIL` confirms with your account email instead of the interactive prompt.",
"examples": [
{
"description": "List what would be deleted, without deleting anything.",
"command": "rig account delete --dry-run"
},
{
"description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation permanently deletes the account.",
"command": "rig account delete --confirm EMAIL"
},
{
"description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.",
"command": "rig account delete --help"
}
],
"warning": "This command permanently deletes your account and everything it owns. Run it with `--dry-run` first and copy out anything you need."
},
"ai": {
"description": "Run this command in an authenticated local terminal or inside a workspace; see the availability above.",
"examples": [
Expand Down
Loading
Loading