diff --git a/cli-reference/cli.mdx b/cli-reference/cli.mdx index 70075c0..aa72fb1 100644 --- a/cli-reference/cli.mdx +++ b/cli-reference/cli.mdx @@ -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 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). @@ -12,6 +12,7 @@ Start with [installation](/guides/install-cli) and [authentication](/cli-referen 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) @@ -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. diff --git a/cli-reference/command-notes.json b/cli-reference/command-notes.json index ec694b2..8a26bc1 100644 --- a/cli-reference/command-notes.json +++ b/cli-reference/command-notes.json @@ -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": [ diff --git a/cli-reference/command-surface.json b/cli-reference/command-surface.json index 9c37956..2f964d3 100644 --- a/cli-reference/command-surface.json +++ b/cli-reference/command-surface.json @@ -220,10 +220,448 @@ "required": false } ], - "help": "Manage Rigbox workspaces, apps, and tools\n\nUsage: rigbox [OPTIONS] \n\nCommands:\n ai Configure account-level AI defaults and view usage\n api Send a raw authenticated request to the Rigbox API\n api-key Manage account API keys\n ci Manage GitHub Actions deployment bindings\n capacity Show fleet workspace-slot capacity\n config View or set persisted CLI defaults (output, pager)\n completions Generate or install a shell completion script\n limits Show effective resource limits and current usage\n login Authenticate with Rigbox\n logout Remove saved credentials\n service-spec Manage account-level service specs\n setup-script Manage reusable workspace setup scripts\n ssh Manage SSH public keys for your account\n status Show dashboard summary for the current account\n uninstall Remove the local Rigbox CLI install\n update Update the Rigbox CLI to the latest published release\n whoami Show the current user and workspace\n app Manage apps inside a workspace\n init Scaffold a rig.yaml for the current directory\n snapshot Manage workspace snapshots\n volume Manage persistent volumes\n build Build reproducible images and view build logs\n release Manage workspace releases\n app-release List and roll back apps without replacing the workspace\n rollback Reverse a preview promotion, or activate a specific release\n tools Launch and manage workspace tools\n deploy Deploy the project from its rig.yaml\n publish Publish the project to the community registry\n workspace Manage workspace lifecycle and configuration\n recipe Publish and install community recipes\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n --output \n Output format [default: human, or `rig config set output \u2026`]\n \n [possible values: human, json, yaml, text, table]\n\n --query \n Filter output with a JMESPath expression\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --no-pager\n Do not pipe help output through a pager\n\n -v, --verbose\n Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`\n\n -h, --help\n Print help\n\n -V, --version\n Print version\n", + "help": "Manage Rigbox workspaces, apps, and tools\n\nUsage: rigbox [OPTIONS] \n\nCommands:\n account Manage your Rigbox account\n ai Configure account-level AI defaults and view usage\n api Send a raw authenticated request to the Rigbox API\n api-key Manage account API keys\n ci Manage GitHub Actions deployment bindings\n capacity Show fleet workspace-slot capacity\n config View or set persisted CLI defaults (output, pager)\n completions Generate or install a shell completion script\n limits Show effective resource limits and current usage\n login Authenticate with Rigbox\n logout Remove saved credentials\n service-spec Manage account-level service specs\n setup-script Manage reusable workspace setup scripts\n ssh Manage SSH public keys for your account\n status Show dashboard summary for the current account\n uninstall Remove the local Rigbox CLI install\n update Update the Rigbox CLI to the latest published release\n whoami Show the current user and workspace\n app Manage apps inside a workspace\n init Scaffold a rig.yaml for the current directory\n snapshot Manage workspace snapshots\n volume Manage persistent volumes\n build Build reproducible images and view build logs\n release Manage workspace releases\n app-release List and roll back apps without replacing the workspace\n rollback Reverse a preview promotion, or activate a specific release\n tools Launch and manage workspace tools\n deploy Deploy the project from its rig.yaml\n publish Publish the project to the community registry\n workspace Manage workspace lifecycle and configuration\n recipe Publish and install community recipes\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n --output \n Output format [default: human, or `rig config set output \u2026`]\n \n [possible values: human, json, yaml, text, table]\n\n --query \n Filter output with a JMESPath expression\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --no-pager\n Do not pipe help output through a pager\n\n -v, --verbose\n Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`\n\n -h, --help\n Print help\n\n -V, --version\n Print version\n", "path": [], "usage": "Usage: rigbox [OPTIONS] " }, + { + "about": "Manage your Rigbox account", + "aliases": [], + "arguments": [ + { + "action": "Set", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": true, + "help": "Output format [default: human, or `rig config set output \u2026`]", + "id": "output", + "long": "output", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "OUTPUT" + ], + "values": [ + "human", + "json", + "yaml", + "text", + "table" + ] + }, + { + "action": "Set", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": true, + "help": "Filter output with a JMESPath expression", + "id": "query", + "long": "query", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "JMESPATH" + ], + "values": [] + }, + { + "action": "Set", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": true, + "help": "Read inputs from a JSON file or '-' (stdin)", + "id": "cli_input_json", + "long": "cli-input-json", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "FILE" + ], + "values": [] + }, + { + "action": "Set", + "aliases": [], + "conflicts": [ + "cli_input_json" + ], + "defaults": [], + "global": true, + "help": "Read inputs from a YAML file or '-' (stdin)", + "id": "cli_input_yaml", + "long": "cli-input-yaml", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "FILE" + ], + "values": [] + }, + { + "action": "SetTrue", + "aliases": [], + "conflicts": [], + "defaults": [ + "false" + ], + "global": true, + "help": "Print a fillable input template, then exit", + "id": "generate_cli_skeleton", + "long": "generate-cli-skeleton", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "GENERATE_CLI_SKELETON" + ], + "values": [] + }, + { + "action": "SetTrue", + "aliases": [], + "conflicts": [], + "defaults": [ + "false" + ], + "global": true, + "help": "Do not pipe help output through a pager", + "id": "no_pager", + "long": "no-pager", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "NO_PAGER" + ], + "values": [] + }, + { + "action": "SetTrue", + "aliases": [], + "conflicts": [], + "defaults": [ + "false" + ], + "global": true, + "help": "Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`", + "id": "verbose", + "long": "verbose", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": "v", + "short_aliases": [], + "value_names": [ + "VERBOSE" + ], + "values": [] + }, + { + "action": "Help", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": false, + "help": "Print help", + "id": "help", + "long": "help", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": "h", + "short_aliases": [], + "value_names": [], + "values": [] + } + ], + "groups": [], + "help": "Manage your Rigbox account\n\nUsage: rigbox account [OPTIONS] \n\nCommands:\n delete Permanently delete your account and everything it owns\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n --output \n Output format [default: human, or `rig config set output \u2026`]\n \n [possible values: human, json, yaml, text, table]\n\n --query \n Filter output with a JMESPath expression\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --no-pager\n Do not pipe help output through a pager\n\n -v, --verbose\n Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`\n\n -h, --help\n Print help\n", + "path": [ + "account" + ], + "usage": "Usage: rigbox account [OPTIONS] " + }, + { + "about": "Permanently delete your account and everything it owns", + "aliases": [], + "arguments": [ + { + "action": "Set", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": false, + "help": "Your account email, to confirm without an interactive prompt", + "id": "confirm", + "long": "confirm", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "EMAIL" + ], + "values": [] + }, + { + "action": "SetTrue", + "aliases": [], + "conflicts": [], + "defaults": [ + "false" + ], + "global": false, + "help": "Show what would be deleted, then exit without deleting anything", + "id": "dry_run", + "long": "dry-run", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": "n", + "short_aliases": [], + "value_names": [ + "DRY_RUN" + ], + "values": [] + }, + { + "action": "Set", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": true, + "help": "Output format [default: human, or `rig config set output \u2026`]", + "id": "output", + "long": "output", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "OUTPUT" + ], + "values": [ + "human", + "json", + "yaml", + "text", + "table" + ] + }, + { + "action": "Set", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": true, + "help": "Filter output with a JMESPath expression", + "id": "query", + "long": "query", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "JMESPATH" + ], + "values": [] + }, + { + "action": "Set", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": true, + "help": "Read inputs from a JSON file or '-' (stdin)", + "id": "cli_input_json", + "long": "cli-input-json", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "FILE" + ], + "values": [] + }, + { + "action": "Set", + "aliases": [], + "conflicts": [ + "cli_input_json" + ], + "defaults": [], + "global": true, + "help": "Read inputs from a YAML file or '-' (stdin)", + "id": "cli_input_yaml", + "long": "cli-input-yaml", + "num_args": { + "max": 1, + "min": 1 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "FILE" + ], + "values": [] + }, + { + "action": "SetTrue", + "aliases": [], + "conflicts": [], + "defaults": [ + "false" + ], + "global": true, + "help": "Print a fillable input template, then exit", + "id": "generate_cli_skeleton", + "long": "generate-cli-skeleton", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "GENERATE_CLI_SKELETON" + ], + "values": [] + }, + { + "action": "SetTrue", + "aliases": [], + "conflicts": [], + "defaults": [ + "false" + ], + "global": true, + "help": "Do not pipe help output through a pager", + "id": "no_pager", + "long": "no-pager", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": null, + "short_aliases": [], + "value_names": [ + "NO_PAGER" + ], + "values": [] + }, + { + "action": "SetTrue", + "aliases": [], + "conflicts": [], + "defaults": [ + "false" + ], + "global": true, + "help": "Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`", + "id": "verbose", + "long": "verbose", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": "v", + "short_aliases": [], + "value_names": [ + "VERBOSE" + ], + "values": [] + }, + { + "action": "Help", + "aliases": [], + "conflicts": [], + "defaults": [], + "global": false, + "help": "Print help", + "id": "help", + "long": "help", + "num_args": { + "max": 0, + "min": 0 + }, + "required": false, + "short": "h", + "short_aliases": [], + "value_names": [], + "values": [] + } + ], + "groups": [ + { + "arguments": [ + "confirm", + "dry_run" + ], + "id": "Delete", + "required": false + } + ], + "help": "Permanently delete your account and everything it owns\n\nUsage: rigbox account delete [OPTIONS]\n\nOptions:\n --confirm \n Your account email, to confirm without an interactive prompt\n\n --output \n Output format [default: human, or `rig config set output \u2026`]\n \n [possible values: human, json, yaml, text, table]\n\n -n, --dry-run\n Show what would be deleted, then exit without deleting anything\n\n --query \n Filter output with a JMESPath expression\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --no-pager\n Do not pipe help output through a pager\n\n -v, --verbose\n Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`\n\n -h, --help\n Print help\n", + "path": [ + "account", + "delete" + ], + "usage": "Usage: rigbox account delete [OPTIONS]" + }, { "about": "Configure account-level AI defaults and view usage", "aliases": [], @@ -2158,7 +2596,7 @@ } ], "groups": [], - "help": "Manage GitHub Actions deployment bindings\n\nUsage: rigbox ci [OPTIONS] \n\nCommands:\n link Bind a GitHub repository to an existing workspace\n status Show repository bindings and their pending or active state\n unlink Remove a repository binding and revoke its deploy credentials\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n --output \n Output format [default: human, or `rig config set output \u2026`]\n \n [possible values: human, json, yaml, text, table]\n\n --query \n Filter output with a JMESPath expression\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --no-pager\n Do not pipe help output through a pager\n\n -v, --verbose\n Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`\n\n -h, --help\n Print help\n", + "help": "Manage GitHub Actions deployment bindings\n\nUsage: rigbox ci [OPTIONS] \n\nCommands:\n link Bind a GitHub repository to an existing workspace\n status Show repository bindings, and GitHub connections with each declared secret's state\n unlink Remove a repository binding and revoke its deploy credentials\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n --output \n Output format [default: human, or `rig config set output \u2026`]\n \n [possible values: human, json, yaml, text, table]\n\n --query \n Filter output with a JMESPath expression\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --no-pager\n Do not pipe help output through a pager\n\n -v, --verbose\n Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`\n\n -h, --help\n Print help\n", "path": [ "ci" ], @@ -2457,7 +2895,7 @@ "usage": "Usage: rigbox ci link [OPTIONS] --repo --workspace " }, { - "about": "Show repository bindings and their pending or active state", + "about": "Show repository bindings, and GitHub connections with each declared secret's state", "aliases": [], "arguments": [ { @@ -2671,7 +3109,7 @@ "required": false } ], - "help": "Show repository bindings and their pending or active state\n\nUsage: rigbox ci status [OPTIONS]\n\nOptions:\n --output \n Output format [default: human, or `rig config set output \u2026`]\n \n [possible values: human, json, yaml, text, table]\n\n --repo \n Filter by GitHub owner/repository\n\n --query \n Filter output with a JMESPath expression\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --no-pager\n Do not pipe help output through a pager\n\n -v, --verbose\n Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`\n\n -h, --help\n Print help\n", + "help": "Show repository bindings, and GitHub connections with each declared secret's state\n\nUsage: rigbox ci status [OPTIONS]\n\nOptions:\n --output \n Output format [default: human, or `rig config set output \u2026`]\n \n [possible values: human, json, yaml, text, table]\n\n --repo \n Filter by GitHub owner/repository\n\n --query \n Filter output with a JMESPath expression\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --no-pager\n Do not pipe help output through a pager\n\n -v, --verbose\n Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`\n\n -h, --help\n Print help\n", "path": [ "ci", "status" @@ -34159,9 +34597,9 @@ "usage": "Usage: rigbox recipe app deprecate [OPTIONS] --ref " } ], - "revision": "1880d04137a5f0bb323170fe5ef0e634b7570f03", + "revision": "824aefd6ad160fcefeaf23abaf8b5e3318be138e", "schema_version": 1, - "version": "0.13.0-rc.4", + "version": "0.13.0-rc.5", "workspace": [ { "about": "Manage the current Rigbox workspace from inside it", @@ -34304,6 +34742,7 @@ { "arguments": [ "output", + "query", "no_pager", "verbose" ], diff --git a/cli-reference/commands/account.mdx b/cli-reference/commands/account.mdx new file mode 100644 index 0000000..4867f9d --- /dev/null +++ b/cli-reference/commands/account.mdx @@ -0,0 +1,81 @@ +--- +title: "rig account" +sidebarTitle: "account" +description: "Manage your Rigbox account" +--- + +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). + +Run this command on your local machine. It isn't available inside a workspace. + +## Examples + +Inspect the supported arguments before running this command. Help is offline and does not modify resources. + +```bash +rig account --help +``` + +## Local syntax + +```text +Usage: rigbox account [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 | +| `--cli-input-json` | Read inputs from a JSON file or '-' (stdin) | Global; Value: FILE | +| `--cli-input-yaml` | Read inputs from a YAML file or '-' (stdin) | Global; Value: FILE; Conflicts: cli_input_json | +| `--generate-cli-skeleton` | Print a fillable input template, then exit | Global; Default: false | +| `--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, and transport commands. Useful for debugging a slow or stuck `rig deploy` | Global; Default: false | +| `-h, --help` | Print help | | + + + +```text +Manage your Rigbox account + +Usage: rigbox account [OPTIONS] + +Commands: + delete Permanently delete your account and everything it owns + help Print this message or the help of the given subcommand(s) + +Options: + --output + Output format [default: human, or `rig config set output …`] + + [possible values: human, json, yaml, text, table] + + --query + Filter output with a JMESPath expression + + --cli-input-json + Read inputs from a JSON file or '-' (stdin) + + --cli-input-yaml + Read inputs from a YAML file or '-' (stdin) + + --generate-cli-skeleton + Print a fillable input template, then exit + + --no-pager + Do not pipe help output through a pager + + -v, --verbose + Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy` + + -h, --help + Print help +``` + + + +## Subcommands + +- [delete](/cli-reference/commands/account/delete) diff --git a/cli-reference/commands/account/delete.mdx b/cli-reference/commands/account/delete.mdx new file mode 100644 index 0000000..cc00964 --- /dev/null +++ b/cli-reference/commands/account/delete.mdx @@ -0,0 +1,97 @@ +--- +title: "rig account delete" +sidebarTitle: "delete" +description: "Permanently delete your account and everything it owns" +--- + +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). + +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 + + +This command permanently deletes your account and everything it owns. Run it with `--dry-run` first and copy out anything you need. + + +List what would be deleted, without deleting anything. + +```bash +rig account delete --dry-run +``` + +Run from your local terminal. Replace uppercase placeholders with your own values. This invocation permanently deletes the account. + +```bash +rig account delete --confirm EMAIL +``` + +Inspect the supported arguments before running this command. Help is offline and does not modify resources. + +```bash +rig account delete --help +``` + +## Local syntax + +```text +Usage: rigbox account delete [OPTIONS] +``` + +### Arguments and flags + +| Argument | Description | Details | +| --- | --- | --- | +| `--confirm` | Your account email, to confirm without an interactive prompt | Value: EMAIL | +| `-n, --dry-run` | Show what would be deleted, then exit without deleting anything | Default: false | +| `--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 | +| `--cli-input-json` | Read inputs from a JSON file or '-' (stdin) | Global; Value: FILE | +| `--cli-input-yaml` | Read inputs from a YAML file or '-' (stdin) | Global; Value: FILE; Conflicts: cli_input_json | +| `--generate-cli-skeleton` | Print a fillable input template, then exit | Global; Default: false | +| `--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, and transport commands. Useful for debugging a slow or stuck `rig deploy` | Global; Default: false | +| `-h, --help` | Print help | | + + + +```text +Permanently delete your account and everything it owns + +Usage: rigbox account delete [OPTIONS] + +Options: + --confirm + Your account email, to confirm without an interactive prompt + + --output + Output format [default: human, or `rig config set output …`] + + [possible values: human, json, yaml, text, table] + + -n, --dry-run + Show what would be deleted, then exit without deleting anything + + --query + Filter output with a JMESPath expression + + --cli-input-json + Read inputs from a JSON file or '-' (stdin) + + --cli-input-yaml + Read inputs from a YAML file or '-' (stdin) + + --generate-cli-skeleton + Print a fillable input template, then exit + + --no-pager + Do not pipe help output through a pager + + -v, --verbose + Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy` + + -h, --help + Print help +``` + + diff --git a/cli-reference/commands/ai.mdx b/cli-reference/commands/ai.mdx index 4c04675..69eb8a1 100644 --- a/cli-reference/commands/ai.mdx +++ b/cli-reference/commands/ai.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ai" description: "Configure account-level AI defaults and view usage" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/ai/defaults.mdx b/cli-reference/commands/ai/defaults.mdx index da3a83c..04487ed 100644 --- a/cli-reference/commands/ai/defaults.mdx +++ b/cli-reference/commands/ai/defaults.mdx @@ -4,7 +4,7 @@ sidebarTitle: "defaults" description: "Show account-level AI defaults, or update them with any flag" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). 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. diff --git a/cli-reference/commands/ai/usage.mdx b/cli-reference/commands/ai/usage.mdx index 8a7194d..5ed587d 100644 --- a/cli-reference/commands/ai/usage.mdx +++ b/cli-reference/commands/ai/usage.mdx @@ -4,7 +4,7 @@ sidebarTitle: "usage" description: "Show AI usage history" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/api-key.mdx b/cli-reference/commands/api-key.mdx index 1e42666..a07b580 100644 --- a/cli-reference/commands/api-key.mdx +++ b/cli-reference/commands/api-key.mdx @@ -4,7 +4,7 @@ sidebarTitle: "api-key" description: "Manage account API keys" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command on your local machine. Inside a workspace, `rig api-key` refuses with a one-line message; run it from your laptop. diff --git a/cli-reference/commands/api-key/create.mdx b/cli-reference/commands/api-key/create.mdx index 930a78d..afd3dab 100644 --- a/cli-reference/commands/api-key/create.mdx +++ b/cli-reference/commands/api-key/create.mdx @@ -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.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/api-key/ls.mdx b/cli-reference/commands/api-key/ls.mdx index d90119a..8714b30 100644 --- a/cli-reference/commands/api-key/ls.mdx +++ b/cli-reference/commands/api-key/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List your API keys" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/api-key/rm.mdx b/cli-reference/commands/api-key/rm.mdx index 3d58bd5..b439609 100644 --- a/cli-reference/commands/api-key/rm.mdx +++ b/cli-reference/commands/api-key/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Revoke an API key" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/api.mdx b/cli-reference/commands/api.mdx index dc76ba8..ca041e6 100644 --- a/cli-reference/commands/api.mdx +++ b/cli-reference/commands/api.mdx @@ -4,7 +4,7 @@ sidebarTitle: "api" description: "Send a raw authenticated request to the Rigbox API" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Sends an authenticated request to the Rigbox API and prints the JSON response. `--body` takes inline JSON, a path to a JSON file, or `-` for standard input; a body that is not valid JSON fails before anything is sent. When the server answers with an error, the response body is printed as it was sent and the command exits non-zero; with `--output json`, the error event carries `status` and `body`. Inside a workspace, requests go through the workspace bridge, which serves only that workspace's routes. diff --git a/cli-reference/commands/app-release.mdx b/cli-reference/commands/app-release.mdx index 5c5717b..e8ca693 100644 --- a/cli-reference/commands/app-release.mdx +++ b/cli-reference/commands/app-release.mdx @@ -4,7 +4,7 @@ sidebarTitle: "app-release" description: "List and roll back apps without replacing the workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/app-release/activate.mdx b/cli-reference/commands/app-release/activate.mdx index e7be1e3..9187367 100644 --- a/cli-reference/commands/app-release/activate.mdx +++ b/cli-reference/commands/app-release/activate.mdx @@ -4,7 +4,7 @@ sidebarTitle: "activate" description: "Activate a ready app release staged with deploy --sync-only" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app-release/logs.mdx b/cli-reference/commands/app-release/logs.mdx index d7f3b32..cfbcbc4 100644 --- a/cli-reference/commands/app-release/logs.mdx +++ b/cli-reference/commands/app-release/logs.mdx @@ -4,7 +4,7 @@ sidebarTitle: "logs" description: "Read app release logs" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app-release/ls.mdx b/cli-reference/commands/app-release/ls.mdx index c56fb70..40c2e5f 100644 --- a/cli-reference/commands/app-release/ls.mdx +++ b/cli-reference/commands/app-release/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List retained app releases (distinct from workspace image releases)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app-release/rollback.mdx b/cli-reference/commands/app-release/rollback.mdx index 7e44f6d..6aefa29 100644 --- a/cli-reference/commands/app-release/rollback.mdx +++ b/cli-reference/commands/app-release/rollback.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rollback" description: "Restore app code and configuration; briefly restarts affected apps, not the workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app.mdx b/cli-reference/commands/app.mdx index 7e6d7e4..fbc761a 100644 --- a/cli-reference/commands/app.mdx +++ b/cli-reference/commands/app.mdx @@ -4,7 +4,7 @@ sidebarTitle: "app" description: "Manage apps inside a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/app/domain.mdx b/cli-reference/commands/app/domain.mdx index edc0514..44bc93e 100644 --- a/cli-reference/commands/app/domain.mdx +++ b/cli-reference/commands/app/domain.mdx @@ -4,7 +4,7 @@ sidebarTitle: "domain" description: "Manage app custom domain" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/app/domain/set.mdx b/cli-reference/commands/app/domain/set.mdx index 1b0b864..50e8389 100644 --- a/cli-reference/commands/app/domain/set.mdx +++ b/cli-reference/commands/app/domain/set.mdx @@ -4,7 +4,7 @@ sidebarTitle: "set" description: "Set a custom domain for an app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/env.mdx b/cli-reference/commands/app/env.mdx index 711c31b..e816604 100644 --- a/cli-reference/commands/app/env.mdx +++ b/cli-reference/commands/app/env.mdx @@ -4,7 +4,7 @@ sidebarTitle: "env" description: "Manage app environment variables" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/app/env/ls.mdx b/cli-reference/commands/app/env/ls.mdx index 321c014..7ba5242 100644 --- a/cli-reference/commands/app/env/ls.mdx +++ b/cli-reference/commands/app/env/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List app environment variables" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/env/set.mdx b/cli-reference/commands/app/env/set.mdx index ad7a354..727b4d2 100644 --- a/cli-reference/commands/app/env/set.mdx +++ b/cli-reference/commands/app/env/set.mdx @@ -4,7 +4,7 @@ sidebarTitle: "set" description: "Set app environment variables (preserves other keys; rig.yaml overrides on deploy)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/env/unset.mdx b/cli-reference/commands/app/env/unset.mdx index a13f7d3..50f0efd 100644 --- a/cli-reference/commands/app/env/unset.mdx +++ b/cli-reference/commands/app/env/unset.mdx @@ -4,7 +4,7 @@ sidebarTitle: "unset" description: "Unset app environment variables (restart the app to apply)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/expose-port.mdx b/cli-reference/commands/app/expose-port.mdx index f4ca477..bfb7620 100644 --- a/cli-reference/commands/app/expose-port.mdx +++ b/cli-reference/commands/app/expose-port.mdx @@ -4,7 +4,7 @@ sidebarTitle: "expose-port" description: "Detect or expose a workspace port as an app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace. `--name` without `--wrap` asks before creating the app route; where it cannot ask (no terminal, JSON output, or CI) it refuses and names `--wrap`. Pass `--wrap --name NAME` to create the route, or leave out both to only detect the listener. diff --git a/cli-reference/commands/app/health.mdx b/cli-reference/commands/app/health.mdx index c067ba8..378fb31 100644 --- a/cli-reference/commands/app/health.mdx +++ b/cli-reference/commands/app/health.mdx @@ -4,7 +4,7 @@ sidebarTitle: "health" description: "Show app runtime health" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/log-source.mdx b/cli-reference/commands/app/log-source.mdx index 7c7afcd..829cb69 100644 --- a/cli-reference/commands/app/log-source.mdx +++ b/cli-reference/commands/app/log-source.mdx @@ -4,7 +4,7 @@ sidebarTitle: "log-source" description: "Manage app log sources" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/app/log-source/add.mdx b/cli-reference/commands/app/log-source/add.mdx index 0ba09ec..7fa5c41 100644 --- a/cli-reference/commands/app/log-source/add.mdx +++ b/cli-reference/commands/app/log-source/add.mdx @@ -4,7 +4,7 @@ sidebarTitle: "add" description: "Add a log source to an app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/log-source/ls.mdx b/cli-reference/commands/app/log-source/ls.mdx index 271c804..f79acc4 100644 --- a/cli-reference/commands/app/log-source/ls.mdx +++ b/cli-reference/commands/app/log-source/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List log sources for an app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/log-source/rm.mdx b/cli-reference/commands/app/log-source/rm.mdx index 586b8a9..4e7f235 100644 --- a/cli-reference/commands/app/log-source/rm.mdx +++ b/cli-reference/commands/app/log-source/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Remove an app log source" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/log-source/update.mdx b/cli-reference/commands/app/log-source/update.mdx index e95ba5f..5e0484f 100644 --- a/cli-reference/commands/app/log-source/update.mdx +++ b/cli-reference/commands/app/log-source/update.mdx @@ -4,7 +4,7 @@ sidebarTitle: "update" description: "Update an app log source" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/logs.mdx b/cli-reference/commands/app/logs.mdx index 3f06c6d..30678fd 100644 --- a/cli-reference/commands/app/logs.mdx +++ b/cli-reference/commands/app/logs.mdx @@ -4,7 +4,7 @@ sidebarTitle: "logs" description: "View app logs" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal or inside a workspace. `--follow` prints new lines as they arrive until you press Ctrl-C; inside a workspace it polls every few seconds where the log stream is not available. `--install` shows the install log, which is where a CLI agent's install output goes. diff --git a/cli-reference/commands/app/ls.mdx b/cli-reference/commands/app/ls.mdx index 974de63..07a3886 100644 --- a/cli-reference/commands/app/ls.mdx +++ b/cli-reference/commands/app/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List apps in a workspace (or all your workspaces)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/new.mdx b/cli-reference/commands/app/new.mdx index 49b4ef7..ea2ad48 100644 --- a/cli-reference/commands/app/new.mdx +++ b/cli-reference/commands/app/new.mdx @@ -4,7 +4,7 @@ sidebarTitle: "new" description: "Create a new app in a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Registers an app for a port in a workspace. Without `--workspace`, it uses the workspace the CLI runs in, or on your laptop the workspace this directory's `rig.yaml` deploys to (its `.rig.lock` binding). Put code on it with `rig deploy`. diff --git a/cli-reference/commands/app/param.mdx b/cli-reference/commands/app/param.mdx index 0849b41..09a07ff 100644 --- a/cli-reference/commands/app/param.mdx +++ b/cli-reference/commands/app/param.mdx @@ -4,7 +4,7 @@ sidebarTitle: "param" description: "Read and write catalog-app parameters" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/app/param/get.mdx b/cli-reference/commands/app/param/get.mdx index d9072e4..463b2d8 100644 --- a/cli-reference/commands/app/param/get.mdx +++ b/cli-reference/commands/app/param/get.mdx @@ -4,7 +4,7 @@ sidebarTitle: "get" description: "Read a single parameter value" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/param/ls.mdx b/cli-reference/commands/app/param/ls.mdx index 2f70604..b79eeb4 100644 --- a/cli-reference/commands/app/param/ls.mdx +++ b/cli-reference/commands/app/param/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List all declared parameters and their current values" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/param/set.mdx b/cli-reference/commands/app/param/set.mdx index 2b22f5f..20dd31f 100644 --- a/cli-reference/commands/app/param/set.mdx +++ b/cli-reference/commands/app/param/set.mdx @@ -4,7 +4,7 @@ sidebarTitle: "set" description: "Set one or more parameter values" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/param/unset.mdx b/cli-reference/commands/app/param/unset.mdx index 972bf87..b69eb11 100644 --- a/cli-reference/commands/app/param/unset.mdx +++ b/cli-reference/commands/app/param/unset.mdx @@ -4,7 +4,7 @@ sidebarTitle: "unset" description: "Reset parameters to their defaults" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/restart.mdx b/cli-reference/commands/app/restart.mdx index f30c559..96c2fa4 100644 --- a/cli-reference/commands/app/restart.mdx +++ b/cli-reference/commands/app/restart.mdx @@ -4,7 +4,7 @@ sidebarTitle: "restart" description: "Restart an app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/rm.mdx b/cli-reference/commands/app/rm.mdx index 0ce05d2..57c07c1 100644 --- a/cli-reference/commands/app/rm.mdx +++ b/cli-reference/commands/app/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Delete an app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/share.mdx b/cli-reference/commands/app/share.mdx index 3aa2502..fa5319b 100644 --- a/cli-reference/commands/app/share.mdx +++ b/cli-reference/commands/app/share.mdx @@ -4,7 +4,7 @@ sidebarTitle: "share" description: "Set app visibility (public, private, or emails)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/start.mdx b/cli-reference/commands/app/start.mdx index 0f43d82..dc64dc4 100644 --- a/cli-reference/commands/app/start.mdx +++ b/cli-reference/commands/app/start.mdx @@ -4,7 +4,7 @@ sidebarTitle: "start" description: "Start an app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/stop.mdx b/cli-reference/commands/app/stop.mdx index f21ae5c..c7870c3 100644 --- a/cli-reference/commands/app/stop.mdx +++ b/cli-reference/commands/app/stop.mdx @@ -4,7 +4,7 @@ sidebarTitle: "stop" description: "Stop an app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/app/verify-domain.mdx b/cli-reference/commands/app/verify-domain.mdx index d92fd38..3b0f941 100644 --- a/cli-reference/commands/app/verify-domain.mdx +++ b/cli-reference/commands/app/verify-domain.mdx @@ -4,7 +4,7 @@ sidebarTitle: "verify-domain" description: "Re-check DNS for an app custom domain" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/build.mdx b/cli-reference/commands/build.mdx index fe5e3d2..9e9b020 100644 --- a/cli-reference/commands/build.mdx +++ b/cli-reference/commands/build.mdx @@ -4,7 +4,7 @@ sidebarTitle: "build" description: "Build reproducible images and view build logs" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/build/image.mdx b/cli-reference/commands/build/image.mdx index 9ee7e5f..4459520 100644 --- a/cli-reference/commands/build/image.mdx +++ b/cli-reference/commands/build/image.mdx @@ -4,7 +4,7 @@ sidebarTitle: "image" description: "Build a reproducible image for a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/build/logs.mdx b/cli-reference/commands/build/logs.mdx index 775c377..e81e5bc 100644 --- a/cli-reference/commands/build/logs.mdx +++ b/cli-reference/commands/build/logs.mdx @@ -4,7 +4,7 @@ sidebarTitle: "logs" description: "View host build logs for a build (the builder's install output)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/build/ls.mdx b/cli-reference/commands/build/ls.mdx index 03c62a7..de36532 100644 --- a/cli-reference/commands/build/ls.mdx +++ b/cli-reference/commands/build/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List your recent image builds (including failed ones)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/capacity.mdx b/cli-reference/commands/capacity.mdx index 4e6e4e1..89fc683 100644 --- a/cli-reference/commands/capacity.mdx +++ b/cli-reference/commands/capacity.mdx @@ -4,7 +4,7 @@ sidebarTitle: "capacity" description: "Show fleet workspace-slot capacity" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/ci.mdx b/cli-reference/commands/ci.mdx index 6060e53..8b3b2e6 100644 --- a/cli-reference/commands/ci.mdx +++ b/cli-reference/commands/ci.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ci" description: "Manage GitHub Actions deployment bindings" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command on your local machine. Inside a workspace, `rig ci` refuses with a one-line message; run it from your laptop. @@ -44,7 +44,7 @@ Usage: rigbox ci [OPTIONS] Commands: link Bind a GitHub repository to an existing workspace - status Show repository bindings and their pending or active state + status Show repository bindings, and GitHub connections with each declared secret's state unlink Remove a repository binding and revoke its deploy credentials help Print this message or the help of the given subcommand(s) diff --git a/cli-reference/commands/ci/link.mdx b/cli-reference/commands/ci/link.mdx index a6c5f40..e2cabfb 100644 --- a/cli-reference/commands/ci/link.mdx +++ b/cli-reference/commands/ci/link.mdx @@ -4,7 +4,7 @@ sidebarTitle: "link" description: "Bind a GitHub repository to an existing workspace" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/ci/status.mdx b/cli-reference/commands/ci/status.mdx index 8ec39ab..d8777f7 100644 --- a/cli-reference/commands/ci/status.mdx +++ b/cli-reference/commands/ci/status.mdx @@ -1,10 +1,10 @@ --- title: "rig ci status" sidebarTitle: "status" -description: "Show repository bindings and their pending or active state" +description: "Show repository bindings, and GitHub connections with each declared secret's state" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. @@ -45,7 +45,7 @@ Usage: rigbox ci status [OPTIONS] ```text -Show repository bindings and their pending or active state +Show repository bindings, and GitHub connections with each declared secret's state Usage: rigbox ci status [OPTIONS] diff --git a/cli-reference/commands/ci/unlink.mdx b/cli-reference/commands/ci/unlink.mdx index 3bb831a..420c99c 100644 --- a/cli-reference/commands/ci/unlink.mdx +++ b/cli-reference/commands/ci/unlink.mdx @@ -4,7 +4,7 @@ sidebarTitle: "unlink" description: "Remove a repository binding and revoke its deploy credentials" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/completions.mdx b/cli-reference/commands/completions.mdx index 907bf41..8bbfb0e 100644 --- a/cli-reference/commands/completions.mdx +++ b/cli-reference/commands/completions.mdx @@ -4,7 +4,7 @@ sidebarTitle: "completions" description: "Generate or install a shell completion script" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Prints a completion script for your shell, or installs it with `--install`. `--no-rc` only works with `--install`: it installs the script and prints the lines to add to your shell configuration instead of editing it. Works in your local terminal and inside a workspace. diff --git a/cli-reference/commands/config.mdx b/cli-reference/commands/config.mdx index 75fd24e..1f97170 100644 --- a/cli-reference/commands/config.mdx +++ b/cli-reference/commands/config.mdx @@ -4,7 +4,7 @@ sidebarTitle: "config" description: "View or set persisted CLI defaults (output, pager)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/config/get.mdx b/cli-reference/commands/config/get.mdx index 1094412..9270015 100644 --- a/cli-reference/commands/config/get.mdx +++ b/cli-reference/commands/config/get.mdx @@ -4,7 +4,7 @@ sidebarTitle: "get" description: "Print a configured default" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/config/list.mdx b/cli-reference/commands/config/list.mdx index b014d95..81c3f7d 100644 --- a/cli-reference/commands/config/list.mdx +++ b/cli-reference/commands/config/list.mdx @@ -4,7 +4,7 @@ sidebarTitle: "list" description: "List configured defaults" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/config/set.mdx b/cli-reference/commands/config/set.mdx index d7ec91e..58759ca 100644 --- a/cli-reference/commands/config/set.mdx +++ b/cli-reference/commands/config/set.mdx @@ -4,7 +4,7 @@ sidebarTitle: "set" description: "Set a default: `rig config set output yaml`" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/config/unset.mdx b/cli-reference/commands/config/unset.mdx index 1530fa9..a4f5ec0 100644 --- a/cli-reference/commands/config/unset.mdx +++ b/cli-reference/commands/config/unset.mdx @@ -4,7 +4,7 @@ sidebarTitle: "unset" description: "Clear a default (revert to the built-in)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/deploy.mdx b/cli-reference/commands/deploy.mdx index 0fd455c..51cd6e7 100644 --- a/cli-reference/commands/deploy.mdx +++ b/cli-reference/commands/deploy.mdx @@ -4,7 +4,7 @@ sidebarTitle: "deploy" description: "Deploy the project from its rig.yaml" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Deploys the project from the directory containing `rig.yaml`. On your laptop it targets `--workspace`, else the workspace bound in `.rig.lock`, else a new one. Inside a workspace it deploys into that workspace only: naming another workspace, `--bluegreen`, `--promote`, `--reimage`, and image deploys refuse before any work starts. diff --git a/cli-reference/commands/init.mdx b/cli-reference/commands/init.mdx index 426c017..e0146ef 100644 --- a/cli-reference/commands/init.mdx +++ b/cli-reference/commands/init.mdx @@ -4,7 +4,7 @@ sidebarTitle: "init" description: "Scaffold a rig.yaml for the current directory" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Scaffolds `rig.yaml` for the current directory. The app name comes from `--name`, or from the directory name, and is converted to lowercase letters, digits, and dashes (at most 48 characters) so that `rig deploy` accepts it. An existing `rig.yaml` is kept unless you pass `--force`. diff --git a/cli-reference/commands/limits.mdx b/cli-reference/commands/limits.mdx index f750b4c..bd34855 100644 --- a/cli-reference/commands/limits.mdx +++ b/cli-reference/commands/limits.mdx @@ -4,7 +4,7 @@ sidebarTitle: "limits" description: "Show effective resource limits and current usage" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/login.mdx b/cli-reference/commands/login.mdx index 640129f..1f38e2f 100644 --- a/cli-reference/commands/login.mdx +++ b/cli-reference/commands/login.mdx @@ -4,7 +4,7 @@ sidebarTitle: "login" description: "Authenticate with Rigbox" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Signing in also sets up SSH access to your workspaces from this machine, as `rig ssh add` does. Without a terminal, set `RIG_API_KEY` for each command or pipe a key to `rig login --import-token`. Inside a workspace, this command refuses with a one-line message; run it from your laptop. The CLI there is already signed in as the workspace. diff --git a/cli-reference/commands/logout.mdx b/cli-reference/commands/logout.mdx index bcd8d20..37e34fb 100644 --- a/cli-reference/commands/logout.mdx +++ b/cli-reference/commands/logout.mdx @@ -4,7 +4,7 @@ sidebarTitle: "logout" description: "Remove saved credentials" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message; run it from your laptop. The CLI in a workspace is signed in as that workspace and has no saved key to remove. diff --git a/cli-reference/commands/proxy.mdx b/cli-reference/commands/proxy.mdx index c87ecc4..898419e 100644 --- a/cli-reference/commands/proxy.mdx +++ b/cli-reference/commands/proxy.mdx @@ -4,7 +4,7 @@ sidebarTitle: "proxy" description: "Managed AI proxy helpers" --- -Available **workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/proxy/dotenv.mdx b/cli-reference/commands/proxy/dotenv.mdx index ba8906b..3083862 100644 --- a/cli-reference/commands/proxy/dotenv.mdx +++ b/cli-reference/commands/proxy/dotenv.mdx @@ -4,7 +4,7 @@ sidebarTitle: "dotenv" description: "Write a .env file with proxy configuration" --- -Available **workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command inside a workspace. diff --git a/cli-reference/commands/proxy/env.mdx b/cli-reference/commands/proxy/env.mdx index b858276..98efec3 100644 --- a/cli-reference/commands/proxy/env.mdx +++ b/cli-reference/commands/proxy/env.mdx @@ -4,7 +4,7 @@ sidebarTitle: "env" description: "Print export statements for scripting (alias for on)" --- -Available **workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command inside a workspace. diff --git a/cli-reference/commands/proxy/off.mdx b/cli-reference/commands/proxy/off.mdx index b884e58..732566f 100644 --- a/cli-reference/commands/proxy/off.mdx +++ b/cli-reference/commands/proxy/off.mdx @@ -4,7 +4,7 @@ sidebarTitle: "off" description: "Print unset statements to deactivate the proxy" --- -Available **workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command inside a workspace. Prints `unset` statements for the variables `rig proxy on` sets, but only those that still point at the managed proxy or hold its placeholder key; your own provider keys and base URLs are left alone. Apply the output with eval, as for `rig proxy on`. diff --git a/cli-reference/commands/proxy/on.mdx b/cli-reference/commands/proxy/on.mdx index 2735b49..d2cbca6 100644 --- a/cli-reference/commands/proxy/on.mdx +++ b/cli-reference/commands/proxy/on.mdx @@ -4,7 +4,7 @@ sidebarTitle: "on" description: "Print export statements to activate the proxy" --- -Available **workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command inside a workspace. diff --git a/cli-reference/commands/proxy/path.mdx b/cli-reference/commands/proxy/path.mdx index 4841220..c4dc4cf 100644 --- a/cli-reference/commands/proxy/path.mdx +++ b/cli-reference/commands/proxy/path.mdx @@ -4,7 +4,7 @@ sidebarTitle: "path" description: "Print the path to the sourceable proxy.env file" --- -Available **workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command inside a workspace. diff --git a/cli-reference/commands/proxy/status.mdx b/cli-reference/commands/proxy/status.mdx index b9a7587..2c0c950 100644 --- a/cli-reference/commands/proxy/status.mdx +++ b/cli-reference/commands/proxy/status.mdx @@ -4,7 +4,7 @@ sidebarTitle: "status" description: "Show proxy status, route, and credit balance" --- -Available **workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command inside a workspace. diff --git a/cli-reference/commands/publish.mdx b/cli-reference/commands/publish.mdx index e393a71..29896ee 100644 --- a/cli-reference/commands/publish.mdx +++ b/cli-reference/commands/publish.mdx @@ -4,7 +4,7 @@ sidebarTitle: "publish" description: "Publish the project to the community registry" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe.mdx b/cli-reference/commands/recipe.mdx index 352d86e..ad984cf 100644 --- a/cli-reference/commands/recipe.mdx +++ b/cli-reference/commands/recipe.mdx @@ -4,7 +4,7 @@ sidebarTitle: "recipe" description: "Publish and install community recipes" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/recipe/app.mdx b/cli-reference/commands/recipe/app.mdx index 00500d0..b1c6cdb 100644 --- a/cli-reference/commands/recipe/app.mdx +++ b/cli-reference/commands/recipe/app.mdx @@ -4,7 +4,7 @@ sidebarTitle: "app" description: "Per-app recipes for installing into existing workspaces" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/recipe/app/delete.mdx b/cli-reference/commands/recipe/app/delete.mdx index d23be7d..418fa10 100644 --- a/cli-reference/commands/recipe/app/delete.mdx +++ b/cli-reference/commands/recipe/app/delete.mdx @@ -4,7 +4,7 @@ sidebarTitle: "delete" description: "Delete published recipe version(s)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/deprecate.mdx b/cli-reference/commands/recipe/app/deprecate.mdx index 4df77c4..8f04e21 100644 --- a/cli-reference/commands/recipe/app/deprecate.mdx +++ b/cli-reference/commands/recipe/app/deprecate.mdx @@ -4,7 +4,7 @@ sidebarTitle: "deprecate" description: "Deprecate a published recipe version" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/health.mdx b/cli-reference/commands/recipe/app/health.mdx index 013703c..8c0b74e 100644 --- a/cli-reference/commands/recipe/app/health.mdx +++ b/cli-reference/commands/recipe/app/health.mdx @@ -4,7 +4,7 @@ sidebarTitle: "health" description: "Show aggregate community registry health" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/info.mdx b/cli-reference/commands/recipe/app/info.mdx index f18532e..74ad8bf 100644 --- a/cli-reference/commands/recipe/app/info.mdx +++ b/cli-reference/commands/recipe/app/info.mdx @@ -4,7 +4,7 @@ sidebarTitle: "info" description: "Show a manifest summary or deploy preview" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/init.mdx b/cli-reference/commands/recipe/app/init.mdx index d823201..0d871de 100644 --- a/cli-reference/commands/recipe/app/init.mdx +++ b/cli-reference/commands/recipe/app/init.mdx @@ -4,7 +4,7 @@ sidebarTitle: "init" description: "Scaffold a community app recipe directory" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/install-record.mdx b/cli-reference/commands/recipe/app/install-record.mdx index da6f62c..a24daf1 100644 --- a/cli-reference/commands/recipe/app/install-record.mdx +++ b/cli-reference/commands/recipe/app/install-record.mdx @@ -4,7 +4,7 @@ sidebarTitle: "install-record" description: "Show the community install record for an installed app" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/install.mdx b/cli-reference/commands/recipe/app/install.mdx index 83906fd..d9d69e6 100644 --- a/cli-reference/commands/recipe/app/install.mdx +++ b/cli-reference/commands/recipe/app/install.mdx @@ -4,7 +4,7 @@ sidebarTitle: "install" description: "Install an exact recipe ref into a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Installs a recipe into an existing workspace. `--ref` takes an exact recipe ref such as `@vendor/slug@1.2.3`, or a built-in catalog ID such as `claude` to add a catalog app or coding agent. The command starts the install and returns. Inside a workspace, pass that workspace's own name or ID to `--workspace`. diff --git a/cli-reference/commands/recipe/app/lint.mdx b/cli-reference/commands/recipe/app/lint.mdx index c1d7f81..584aa55 100644 --- a/cli-reference/commands/recipe/app/lint.mdx +++ b/cli-reference/commands/recipe/app/lint.mdx @@ -4,7 +4,7 @@ sidebarTitle: "lint" description: "Validate a rig.yaml against the canonical schema" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/ls.mdx b/cli-reference/commands/recipe/app/ls.mdx index 314dd9e..27abf5f 100644 --- a/cli-reference/commands/recipe/app/ls.mdx +++ b/cli-reference/commands/recipe/app/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List visible app recipes" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/profile.mdx b/cli-reference/commands/recipe/app/profile.mdx index bf48246..a1c0555 100644 --- a/cli-reference/commands/recipe/app/profile.mdx +++ b/cli-reference/commands/recipe/app/profile.mdx @@ -4,7 +4,7 @@ sidebarTitle: "profile" description: "Show or update your community recipe profile" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/test.mdx b/cli-reference/commands/recipe/app/test.mdx index f9706c4..68d5d42 100644 --- a/cli-reference/commands/recipe/app/test.mdx +++ b/cli-reference/commands/recipe/app/test.mdx @@ -4,7 +4,7 @@ sidebarTitle: "test" description: "Lint and print the disposable workspace test plan" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/versions.mdx b/cli-reference/commands/recipe/app/versions.mdx index 50f8ff7..e9b05d3 100644 --- a/cli-reference/commands/recipe/app/versions.mdx +++ b/cli-reference/commands/recipe/app/versions.mdx @@ -4,7 +4,7 @@ sidebarTitle: "versions" description: "List published versions, newest first" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/recipe/app/yank.mdx b/cli-reference/commands/recipe/app/yank.mdx index 3962fe5..eeaf1ec 100644 --- a/cli-reference/commands/recipe/app/yank.mdx +++ b/cli-reference/commands/recipe/app/yank.mdx @@ -4,7 +4,7 @@ sidebarTitle: "yank" description: "Yank a published recipe version" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/release.mdx b/cli-reference/commands/release.mdx index b8a4bdd..998b232 100644 --- a/cli-reference/commands/release.mdx +++ b/cli-reference/commands/release.mdx @@ -4,7 +4,7 @@ sidebarTitle: "release" description: "Manage workspace releases" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command on your local machine. Inside a workspace, `rig release` refuses with a one-line message; run it from your laptop. Image releases replace the workspace. diff --git a/cli-reference/commands/release/activate.mdx b/cli-reference/commands/release/activate.mdx index d504fca..e9f74dc 100644 --- a/cli-reference/commands/release/activate.mdx +++ b/cli-reference/commands/release/activate.mdx @@ -4,7 +4,7 @@ sidebarTitle: "activate" description: "Activate a release for a workspace" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/release/create.mdx b/cli-reference/commands/release/create.mdx index 26a25d5..1e6bb75 100644 --- a/cli-reference/commands/release/create.mdx +++ b/cli-reference/commands/release/create.mdx @@ -4,7 +4,7 @@ sidebarTitle: "create" description: "Create a release pinning an image digest" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/release/ls.mdx b/cli-reference/commands/release/ls.mdx index c524660..cca10e8 100644 --- a/cli-reference/commands/release/ls.mdx +++ b/cli-reference/commands/release/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List releases for a workspace" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/rollback.mdx b/cli-reference/commands/rollback.mdx index 35e8115..ccd6104 100644 --- a/cli-reference/commands/rollback.mdx +++ b/cli-reference/commands/rollback.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rollback" description: "Reverse a preview promotion, or activate a specific release" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message; run it from your laptop. Rolling back replaces the workspace. diff --git a/cli-reference/commands/service-spec.mdx b/cli-reference/commands/service-spec.mdx index cfef837..c025287 100644 --- a/cli-reference/commands/service-spec.mdx +++ b/cli-reference/commands/service-spec.mdx @@ -4,7 +4,7 @@ sidebarTitle: "service-spec" description: "Manage account-level service specs" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/service-spec/create.mdx b/cli-reference/commands/service-spec/create.mdx index 920f9b9..8ce4354 100644 --- a/cli-reference/commands/service-spec/create.mdx +++ b/cli-reference/commands/service-spec/create.mdx @@ -4,7 +4,7 @@ sidebarTitle: "create" description: "Create a new service spec from a YAML file" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, it refuses with a one-line message because account service specs apply to your other workspaces too. `rig service-spec ls` works in both places. diff --git a/cli-reference/commands/service-spec/ls.mdx b/cli-reference/commands/service-spec/ls.mdx index 810d143..18916da 100644 --- a/cli-reference/commands/service-spec/ls.mdx +++ b/cli-reference/commands/service-spec/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List your service specs" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/service-spec/rm.mdx b/cli-reference/commands/service-spec/rm.mdx index b8f7559..c49ead6 100644 --- a/cli-reference/commands/service-spec/rm.mdx +++ b/cli-reference/commands/service-spec/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Delete a service spec" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, it refuses with a one-line message because account service specs apply to your other workspaces too. `rig service-spec ls` works in both places. diff --git a/cli-reference/commands/service-spec/update.mdx b/cli-reference/commands/service-spec/update.mdx index af9d6c0..c043278 100644 --- a/cli-reference/commands/service-spec/update.mdx +++ b/cli-reference/commands/service-spec/update.mdx @@ -4,7 +4,7 @@ sidebarTitle: "update" description: "Update an existing service spec from a YAML file" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, it refuses with a one-line message because account service specs apply to your other workspaces too. `rig service-spec ls` works in both places. diff --git a/cli-reference/commands/setup-script.mdx b/cli-reference/commands/setup-script.mdx index a101a71..5582364 100644 --- a/cli-reference/commands/setup-script.mdx +++ b/cli-reference/commands/setup-script.mdx @@ -4,7 +4,7 @@ sidebarTitle: "setup-script" description: "Manage reusable workspace setup scripts" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/setup-script/create.mdx b/cli-reference/commands/setup-script/create.mdx index 0507193..0bbecd9 100644 --- a/cli-reference/commands/setup-script/create.mdx +++ b/cli-reference/commands/setup-script/create.mdx @@ -4,7 +4,7 @@ sidebarTitle: "create" description: "Create a new setup script from a local file" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, it refuses with a one-line message because account setup scripts run in your other workspaces too. `rig setup-script ls` works in both places. diff --git a/cli-reference/commands/setup-script/ls.mdx b/cli-reference/commands/setup-script/ls.mdx index 888f4fe..a8a06a7 100644 --- a/cli-reference/commands/setup-script/ls.mdx +++ b/cli-reference/commands/setup-script/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List your setup scripts" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/setup-script/rm.mdx b/cli-reference/commands/setup-script/rm.mdx index 6210069..99e470a 100644 --- a/cli-reference/commands/setup-script/rm.mdx +++ b/cli-reference/commands/setup-script/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Delete a setup script" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, it refuses with a one-line message because account setup scripts run in your other workspaces too. `rig setup-script ls` works in both places. diff --git a/cli-reference/commands/setup-script/update.mdx b/cli-reference/commands/setup-script/update.mdx index 505f2e4..45b91f7 100644 --- a/cli-reference/commands/setup-script/update.mdx +++ b/cli-reference/commands/setup-script/update.mdx @@ -4,7 +4,7 @@ sidebarTitle: "update" description: "Update an existing setup script (--name and/or --file)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, it refuses with a one-line message because account setup scripts run in your other workspaces too. `rig setup-script ls` works in both places. diff --git a/cli-reference/commands/snapshot.mdx b/cli-reference/commands/snapshot.mdx index d066a21..8e9fe6d 100644 --- a/cli-reference/commands/snapshot.mdx +++ b/cli-reference/commands/snapshot.mdx @@ -4,7 +4,7 @@ sidebarTitle: "snapshot" description: "Manage workspace snapshots" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/snapshot/create.mdx b/cli-reference/commands/snapshot/create.mdx index ffe2e78..89e67f4 100644 --- a/cli-reference/commands/snapshot/create.mdx +++ b/cli-reference/commands/snapshot/create.mdx @@ -4,7 +4,7 @@ sidebarTitle: "create" description: "Create a workspace snapshot" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/snapshot/ls.mdx b/cli-reference/commands/snapshot/ls.mdx index 97fd5ef..d9ce11a 100644 --- a/cli-reference/commands/snapshot/ls.mdx +++ b/cli-reference/commands/snapshot/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List snapshots (filter by workspace, or all if omitted)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/snapshot/restore.mdx b/cli-reference/commands/snapshot/restore.mdx index 2d1eebd..3dd91c5 100644 --- a/cli-reference/commands/snapshot/restore.mdx +++ b/cli-reference/commands/snapshot/restore.mdx @@ -4,7 +4,7 @@ sidebarTitle: "restore" description: "Restore a snapshot onto its workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/snapshot/rm.mdx b/cli-reference/commands/snapshot/rm.mdx index e03c3e9..6bd8d7a 100644 --- a/cli-reference/commands/snapshot/rm.mdx +++ b/cli-reference/commands/snapshot/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Delete a snapshot" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/ssh.mdx b/cli-reference/commands/ssh.mdx index 41d6bca..96387c6 100644 --- a/cli-reference/commands/ssh.mdx +++ b/cli-reference/commands/ssh.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ssh" description: "Manage SSH public keys for your account" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command on your local machine. Inside a workspace, `rig ssh` refuses with a one-line message; run it from your laptop. Account SSH keys are never managed from inside a workspace. diff --git a/cli-reference/commands/ssh/add.mdx b/cli-reference/commands/ssh/add.mdx index 6786565..56890de 100644 --- a/cli-reference/commands/ssh/add.mdx +++ b/cli-reference/commands/ssh/add.mdx @@ -4,7 +4,7 @@ sidebarTitle: "add" description: "Register an SSH public key and set up `ssh ` on this machine" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Registers a public key on your account and sets up `ssh ` on this machine: a `Host` entry per workspace in `~/.config/rigbox/ssh_config`, which `~/.ssh/config` includes. Without `--file` it uses `~/.ssh/id_ed25519.pub`, then `~/.ssh/id_rsa.pub`, and creates an ed25519 key when you have neither. Without `--name` the key is named `laptop-` followed by your host name. A key that is already on your account is reported, not added again. diff --git a/cli-reference/commands/ssh/ls.mdx b/cli-reference/commands/ssh/ls.mdx index 49514d8..e4f9e43 100644 --- a/cli-reference/commands/ssh/ls.mdx +++ b/cli-reference/commands/ssh/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List registered SSH public keys" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/ssh/rm.mdx b/cli-reference/commands/ssh/rm.mdx index f8e75b4..43dcf20 100644 --- a/cli-reference/commands/ssh/rm.mdx +++ b/cli-reference/commands/ssh/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Remove a registered SSH public key" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Removes a registered key; pass the name or ID that `rig ssh ls` shows. diff --git a/cli-reference/commands/ssh/sync.mdx b/cli-reference/commands/ssh/sync.mdx index ae96003..04acbb4 100644 --- a/cli-reference/commands/ssh/sync.mdx +++ b/cli-reference/commands/ssh/sync.mdx @@ -4,7 +4,7 @@ sidebarTitle: "sync" description: "Push your SSH keys into a workspace" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/status.mdx b/cli-reference/commands/status.mdx index 37a95ca..e40a6ca 100644 --- a/cli-reference/commands/status.mdx +++ b/cli-reference/commands/status.mdx @@ -4,7 +4,7 @@ sidebarTitle: "status" description: "Show dashboard summary for the current account" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/tools.mdx b/cli-reference/commands/tools.mdx index b4d2025..2b42f67 100644 --- a/cli-reference/commands/tools.mdx +++ b/cli-reference/commands/tools.mdx @@ -4,7 +4,7 @@ sidebarTitle: "tools" description: "Launch and manage workspace tools" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/tools/install-status.mdx b/cli-reference/commands/tools/install-status.mdx index 59840aa..ba963e7 100644 --- a/cli-reference/commands/tools/install-status.mdx +++ b/cli-reference/commands/tools/install-status.mdx @@ -4,7 +4,7 @@ sidebarTitle: "install-status" description: "Poll the status of an async tool install" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/tools/install.mdx b/cli-reference/commands/tools/install.mdx index 0a9c3c5..f799ed7 100644 --- a/cli-reference/commands/tools/install.mdx +++ b/cli-reference/commands/tools/install.mdx @@ -4,7 +4,7 @@ sidebarTitle: "install" description: "Install a tool into a workspace (async)" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Installs a tool's dependencies: `architecture` or `virtual-browser`. It returns a job ID for `rig tools install-status`, and fails when the server installs nothing. diff --git a/cli-reference/commands/tools/launch.mdx b/cli-reference/commands/tools/launch.mdx index fc09271..d3abeec 100644 --- a/cli-reference/commands/tools/launch.mdx +++ b/cli-reference/commands/tools/launch.mdx @@ -4,7 +4,7 @@ sidebarTitle: "launch" description: "Launch a tool" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Starts a tool: `architecture` (Architecture Explorer) or `virtual-browser`. The command fails when the server launches nothing. While the tool is still starting, `rig tools ls` shows its status and, once it serves, its URL. diff --git a/cli-reference/commands/tools/ls.mdx b/cli-reference/commands/tools/ls.mdx index 21f7095..32fca10 100644 --- a/cli-reference/commands/tools/ls.mdx +++ b/cli-reference/commands/tools/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List workspace tools with their status and URL" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Lists the workspace's tools: whether each is available, its status (`running`, a launch state such as `starting`, or `idle`), and its URL while it is serving. Use it to read back a launched tool's URL. diff --git a/cli-reference/commands/tools/stop.mdx b/cli-reference/commands/tools/stop.mdx index 885b021..5d066bd 100644 --- a/cli-reference/commands/tools/stop.mdx +++ b/cli-reference/commands/tools/stop.mdx @@ -4,7 +4,7 @@ sidebarTitle: "stop" description: "Stop a tool" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/uninstall.mdx b/cli-reference/commands/uninstall.mdx index 6709909..6477338 100644 --- a/cli-reference/commands/uninstall.mdx +++ b/cli-reference/commands/uninstall.mdx @@ -4,7 +4,7 @@ sidebarTitle: "uninstall" description: "Remove the local Rigbox CLI install" --- -Available **local**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message; run it from your laptop. A workspace image manages its own CLI; update it there with `rig update`. diff --git a/cli-reference/commands/update.mdx b/cli-reference/commands/update.mdx index 62caab8..c9239fc 100644 --- a/cli-reference/commands/update.mdx +++ b/cli-reference/commands/update.mdx @@ -4,7 +4,7 @@ sidebarTitle: "update" description: "Update the Rigbox CLI to the latest published release" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Replaces the running `rig` binary with the latest published release, or with the release tag given to `--version`. It downloads this platform's build from the public release mirror, checks that the download runs, and swaps it in place: `~/.local/bin` after the standard install, `/usr/local/bin` inside a workspace. Set `RIG_INSTALL_DIR` to install into another directory. diff --git a/cli-reference/commands/volume.mdx b/cli-reference/commands/volume.mdx index 714c753..59eab44 100644 --- a/cli-reference/commands/volume.mdx +++ b/cli-reference/commands/volume.mdx @@ -4,7 +4,7 @@ sidebarTitle: "volume" description: "Manage persistent volumes" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/volume/create.mdx b/cli-reference/commands/volume/create.mdx index 24cd96d..b47ccd8 100644 --- a/cli-reference/commands/volume/create.mdx +++ b/cli-reference/commands/volume/create.mdx @@ -4,7 +4,7 @@ sidebarTitle: "create" description: "Create a persistent volume" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/volume/ls.mdx b/cli-reference/commands/volume/ls.mdx index c01a91c..6492ab7 100644 --- a/cli-reference/commands/volume/ls.mdx +++ b/cli-reference/commands/volume/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List volumes in a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/volume/resize.mdx b/cli-reference/commands/volume/resize.mdx index fbc96b7..a60b5f2 100644 --- a/cli-reference/commands/volume/resize.mdx +++ b/cli-reference/commands/volume/resize.mdx @@ -4,7 +4,7 @@ sidebarTitle: "resize" description: "Resize a volume" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/volume/rm.mdx b/cli-reference/commands/volume/rm.mdx index 74afc61..e4ef0de 100644 --- a/cli-reference/commands/volume/rm.mdx +++ b/cli-reference/commands/volume/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Delete a volume" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/whoami.mdx b/cli-reference/commands/whoami.mdx index 044eb7e..a256645 100644 --- a/cli-reference/commands/whoami.mdx +++ b/cli-reference/commands/whoami.mdx @@ -4,7 +4,7 @@ sidebarTitle: "whoami" description: "Show the current user and workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/workspace.mdx b/cli-reference/commands/workspace.mdx index 4b8fd11..54eaeaa 100644 --- a/cli-reference/commands/workspace.mdx +++ b/cli-reference/commands/workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: "workspace" description: "Manage workspace lifecycle and configuration" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/workspace/ai.mdx b/cli-reference/commands/workspace/ai.mdx index c714a78..a2c22f1 100644 --- a/cli-reference/commands/workspace/ai.mdx +++ b/cli-reference/commands/workspace/ai.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ai" description: "Manage workspace AI configuration" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/workspace/ai/mode.mdx b/cli-reference/commands/workspace/ai/mode.mdx index 5af7ecd..0fc9085 100644 --- a/cli-reference/commands/workspace/ai/mode.mdx +++ b/cli-reference/commands/workspace/ai/mode.mdx @@ -4,7 +4,7 @@ sidebarTitle: "mode" description: "Set the workspace AI mode" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/workspace/ai/show.mdx b/cli-reference/commands/workspace/ai/show.mdx index 2ab41ca..13d1bfa 100644 --- a/cli-reference/commands/workspace/ai/show.mdx +++ b/cli-reference/commands/workspace/ai/show.mdx @@ -4,7 +4,7 @@ sidebarTitle: "show" description: "Show AI config for a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/workspace/cancel.mdx b/cli-reference/commands/workspace/cancel.mdx index 7368116..2905a07 100644 --- a/cli-reference/commands/workspace/cancel.mdx +++ b/cli-reference/commands/workspace/cancel.mdx @@ -4,7 +4,7 @@ sidebarTitle: "cancel" description: "Cancel an in-progress workspace creation" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop. diff --git a/cli-reference/commands/workspace/env.mdx b/cli-reference/commands/workspace/env.mdx index cfe5e9d..dd6526e 100644 --- a/cli-reference/commands/workspace/env.mdx +++ b/cli-reference/commands/workspace/env.mdx @@ -4,7 +4,7 @@ sidebarTitle: "env" description: "Manage workspace environment variables" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. diff --git a/cli-reference/commands/workspace/env/get.mdx b/cli-reference/commands/workspace/env/get.mdx index e62246b..5092cbe 100644 --- a/cli-reference/commands/workspace/env/get.mdx +++ b/cli-reference/commands/workspace/env/get.mdx @@ -4,7 +4,7 @@ sidebarTitle: "get" description: "Print workspace environment variables" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/workspace/env/ls.mdx b/cli-reference/commands/workspace/env/ls.mdx index 63d12a3..a600d2b 100644 --- a/cli-reference/commands/workspace/env/ls.mdx +++ b/cli-reference/commands/workspace/env/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List all workspace environment variables" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/workspace/env/set.mdx b/cli-reference/commands/workspace/env/set.mdx index 97446f7..58041f0 100644 --- a/cli-reference/commands/workspace/env/set.mdx +++ b/cli-reference/commands/workspace/env/set.mdx @@ -4,7 +4,7 @@ sidebarTitle: "set" description: "Set one or more environment variables on a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/workspace/env/unset.mdx b/cli-reference/commands/workspace/env/unset.mdx index 694e3a6..8b603f6 100644 --- a/cli-reference/commands/workspace/env/unset.mdx +++ b/cli-reference/commands/workspace/env/unset.mdx @@ -4,7 +4,7 @@ sidebarTitle: "unset" description: "Unset one or more environment variables on a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/workspace/logs.mdx b/cli-reference/commands/workspace/logs.mdx index 111f0b0..dd99e07 100644 --- a/cli-reference/commands/workspace/logs.mdx +++ b/cli-reference/commands/workspace/logs.mdx @@ -4,7 +4,7 @@ sidebarTitle: "logs" description: "View workspace logs" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal or inside a workspace. `--follow` prints new lines as they arrive until you press Ctrl-C; inside a workspace it polls every few seconds where the log stream is not available. Inside a workspace the command reads that workspace's logs and takes no `--workspace`. diff --git a/cli-reference/commands/workspace/ls.mdx b/cli-reference/commands/workspace/ls.mdx index bf2d386..eb7f77b 100644 --- a/cli-reference/commands/workspace/ls.mdx +++ b/cli-reference/commands/workspace/ls.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ls" description: "List all workspaces in your account" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below. diff --git a/cli-reference/commands/workspace/metrics.mdx b/cli-reference/commands/workspace/metrics.mdx index e918508..918a8b0 100644 --- a/cli-reference/commands/workspace/metrics.mdx +++ b/cli-reference/commands/workspace/metrics.mdx @@ -4,7 +4,7 @@ sidebarTitle: "metrics" description: "Show live CPU, RAM, and disk metrics" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace. diff --git a/cli-reference/commands/workspace/new.mdx b/cli-reference/commands/workspace/new.mdx index aaea08a..6db55d1 100644 --- a/cli-reference/commands/workspace/new.mdx +++ b/cli-reference/commands/workspace/new.mdx @@ -4,7 +4,7 @@ sidebarTitle: "new" description: "Create a new workspace without starting it" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop. diff --git a/cli-reference/commands/workspace/ports.mdx b/cli-reference/commands/workspace/ports.mdx index cf46ea8..0c215dd 100644 --- a/cli-reference/commands/workspace/ports.mdx +++ b/cli-reference/commands/workspace/ports.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ports" description: "List ports the workspace is currently listening on" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace. diff --git a/cli-reference/commands/workspace/reconcile.mdx b/cli-reference/commands/workspace/reconcile.mdx index 51e1cc7..2b96a4c 100644 --- a/cli-reference/commands/workspace/reconcile.mdx +++ b/cli-reference/commands/workspace/reconcile.mdx @@ -4,7 +4,7 @@ sidebarTitle: "reconcile" description: "Reconcile workspace apps with the template" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace. diff --git a/cli-reference/commands/workspace/resize.mdx b/cli-reference/commands/workspace/resize.mdx index 664ae38..5264ea0 100644 --- a/cli-reference/commands/workspace/resize.mdx +++ b/cli-reference/commands/workspace/resize.mdx @@ -4,7 +4,7 @@ sidebarTitle: "resize" description: "Resize workspace resources" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace. diff --git a/cli-reference/commands/workspace/restart.mdx b/cli-reference/commands/workspace/restart.mdx index dc3d9bb..350e813 100644 --- a/cli-reference/commands/workspace/restart.mdx +++ b/cli-reference/commands/workspace/restart.mdx @@ -4,7 +4,7 @@ sidebarTitle: "restart" description: "Restart a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. It stops the workspace, starts it again, and waits until it is running. Once the workspace is running, it also sets up SSH access from this machine and prints the short `ssh` alias next to the full command. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop. diff --git a/cli-reference/commands/workspace/retry.mdx b/cli-reference/commands/workspace/retry.mdx index ccca464..8f5dd6a 100644 --- a/cli-reference/commands/workspace/retry.mdx +++ b/cli-reference/commands/workspace/retry.mdx @@ -4,7 +4,7 @@ sidebarTitle: "retry" description: "Retry a workspace that failed during creation" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop. diff --git a/cli-reference/commands/workspace/rm.mdx b/cli-reference/commands/workspace/rm.mdx index 163d721..36e9ee6 100644 --- a/cli-reference/commands/workspace/rm.mdx +++ b/cli-reference/commands/workspace/rm.mdx @@ -4,7 +4,7 @@ sidebarTitle: "rm" description: "Delete a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop. diff --git a/cli-reference/commands/workspace/services.mdx b/cli-reference/commands/workspace/services.mdx index e521c79..222bdb1 100644 --- a/cli-reference/commands/workspace/services.mdx +++ b/cli-reference/commands/workspace/services.mdx @@ -4,7 +4,7 @@ sidebarTitle: "services" description: "List background services tracked in the workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace. diff --git a/cli-reference/commands/workspace/spawn.mdx b/cli-reference/commands/workspace/spawn.mdx index 72980ae..afb2666 100644 --- a/cli-reference/commands/workspace/spawn.mdx +++ b/cli-reference/commands/workspace/spawn.mdx @@ -4,7 +4,7 @@ sidebarTitle: "spawn" description: "Create and start a workspace in one step" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Once the workspace is running, it also sets up SSH access from this machine and prints the short `ssh` alias next to the full command. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop. diff --git a/cli-reference/commands/workspace/ssh-info.mdx b/cli-reference/commands/workspace/ssh-info.mdx index db17f16..d5c975e 100644 --- a/cli-reference/commands/workspace/ssh-info.mdx +++ b/cli-reference/commands/workspace/ssh-info.mdx @@ -4,7 +4,7 @@ sidebarTitle: "ssh-info" description: "Print SSH connection info for a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Prints the workspace's SSH host and user, the short `ssh` alias when rig manages your SSH config, and the full `ssh USER@HOST` command. It also sets up SSH access from this machine, as `rig ssh add` does. Inside a workspace it describes that workspace and takes no `--workspace`. diff --git a/cli-reference/commands/workspace/start.mdx b/cli-reference/commands/workspace/start.mdx index 3a97bfe..4a90c63 100644 --- a/cli-reference/commands/workspace/start.mdx +++ b/cli-reference/commands/workspace/start.mdx @@ -4,7 +4,7 @@ sidebarTitle: "start" description: "Start a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Once the workspace is running, it also sets up SSH access from this machine and prints the short `ssh` alias next to the full command. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop. diff --git a/cli-reference/commands/workspace/stop.mdx b/cli-reference/commands/workspace/stop.mdx index b50a8b8..c5e1913 100644 --- a/cli-reference/commands/workspace/stop.mdx +++ b/cli-reference/commands/workspace/stop.mdx @@ -4,7 +4,7 @@ sidebarTitle: "stop" description: "Stop a workspace" --- -Available **local and workspace**. Reference source: CLI `0.13.0-rc.4` (`1880d04137a5`). +Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop. diff --git a/cli-reference/execution-modes.mdx b/cli-reference/execution-modes.mdx index b751aa3..3eb797a 100644 --- a/cli-reference/execution-modes.mdx +++ b/cli-reference/execution-modes.mdx @@ -99,6 +99,6 @@ The bridge acts for the workspace's owner but serves only what code inside one w ## Resolve a command mismatch -Run `rig --version` and `rig COMMAND --help` in the terminal where the command failed. Check the mode section on that command's reference page. A workspace's installed version may differ from your local installation; run `rig update` in the workspace to bring it up to date. This reference describes CLI revision `1880d04` (version 0.13.0-rc.4). +Run `rig --version` and `rig COMMAND --help` in the terminal where the command failed. Check the mode section on that command's reference page. A workspace's installed version may differ from your local installation; run `rig update` in the workspace to bring it up to date. This reference describes CLI v0.13.0-rc.5 (revision `824aefd`). Continue with [authentication](/cli-reference/authentication) or [configuration and output](/cli-reference/configuration). diff --git a/scripts/cli-examples.json b/scripts/cli-examples.json index 2a243a6..fb1a1e3 100644 --- a/scripts/cli-examples.json +++ b/scripts/cli-examples.json @@ -1,4 +1,44 @@ [ + { + "key": "account:0", + "mode": "local", + "argv": [ + "rig", + "account", + "--help" + ] + }, + { + "key": "account/delete:0", + "mode": "local", + "argv": [ + "rig", + "account", + "delete", + "--dry-run" + ] + }, + { + "key": "account/delete:1", + "mode": "local", + "argv": [ + "rig", + "account", + "delete", + "--confirm", + "EMAIL" + ] + }, + { + "key": "account/delete:2", + "mode": "local", + "argv": [ + "rig", + "account", + "delete", + "--help" + ] + }, { "key": "ai:0", "mode": "local", diff --git a/scripts/cli-navigation.json b/scripts/cli-navigation.json index 4bb71d1..696c363 100644 --- a/scripts/cli-navigation.json +++ b/scripts/cli-navigation.json @@ -1,4 +1,11 @@ [ + { + "group": "account", + "root": "cli-reference/commands/account", + "pages": [ + "cli-reference/commands/account/delete" + ] + }, { "group": "ai", "root": "cli-reference/commands/ai", diff --git a/scripts/generate-cli-reference.md b/scripts/generate-cli-reference.md index eb3f9ca..6a4d72a 100644 --- a/scripts/generate-cli-reference.md +++ b/scripts/generate-cli-reference.md @@ -1,16 +1,8 @@ # CLI reference maintenance -The committed `cli-reference/command-surface.json` describes CLI revision -1880d04137a5f0bb323170fe5ef0e634b7570f03 (version string 0.13.0-rc.4). It was not -produced by the exporter: that revision was not built for documentation, so the file -was reconstructed from the `--help` output of a build of it (local mode, and workspace -mode via `RIGBOX_WORKSPACE_CONFIG`), with global options taken from the revision's -`tests/snapshots/help_snapshots__*_root.snap` and argument metadata that help text -does not show (ids, actions, conflicts, groups, hidden aliases) carried over from the -previous export of v0.13.0-rc.2 (09bd4024dd729ef31ae62f0f6985849974a9651d). The -reconstruction reproduced all 182 commands whose help had not changed byte for byte -before it was applied to the rest. Replace it with a real export when that revision, -or a release containing it, is exported. +The committed `cli-reference/command-surface.json` is an export of CLI v0.13.0-rc.5 +(revision 824aefd6ad160fcefeaf23abaf8b5e3318be138e), made with the exporter below. Every +example in `scripts/cli-examples.json` parses against that revision. Generate the export with `cargo run --example export_docs` from the CLI checkout. The exporter is a Cargo example, not a production command.