diff --git a/cli-reference/authentication.mdx b/cli-reference/authentication.mdx index 3635e4a..9330b5c 100644 --- a/cli-reference/authentication.mdx +++ b/cli-reference/authentication.mdx @@ -22,6 +22,10 @@ rig login --token # paste a token at the prompt rig login --import-token # read a token from stdin and validate it ``` +Without a terminal, for example in a script, `rig login` stops and names what works instead: set `RIG_API_KEY` for each command (it isn't saved), or pipe the key to `rig login --import-token`, which validates and saves it. Only a key the server rejects is reported as invalid; if the server can't be reached, the error says so. + +Signing in also sets up [SSH access](/guides/ssh-access) from this machine. Inside a workspace you don't sign in: the CLI there already acts as the workspace, and `rig login` and `rig logout` refuse. + Once logged in, any command works without further setup, for example: ```bash @@ -57,9 +61,12 @@ To hit any endpoint directly without managing headers, use `rig api`. It reuses ```bash rig api GET /v1/workspaces +rig api PATCH /v1/apps/APP_ID --body '{"name":"web"}' rig api POST /v1/snapshots --body snapshot.json ``` +`--body` takes inline JSON, a path to a JSON file, or `-` to read standard input; a body that isn't valid JSON fails before anything is sent. When the server returns an error, `rig api` prints the response body as the server sent it, reports the HTTP status, and exits non-zero. With `--output json`, the error event carries `status` and `body` alongside `code` and `message`. Inside a workspace, `rig api` sends requests through the workspace bridge, which serves only that workspace's routes. + ## Bearer tokens (JWT) If you authenticate through the dashboard login flow, you receive a short-lived JWT. The dashboard handles refresh automatically — for terminal use, prefer `rig login` (which manages the token for you) or an API key for non-interactive clients. diff --git a/cli-reference/cli.mdx b/cli-reference/cli.mdx index a680ec8..70075c0 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 **v0.13.0-rc.2**. +The `rig` and `rigbox` commands run the same CLI. This reference is generated from CLI revision `1880d04`, which reports its version as **0.13.0-rc.4**. Start with [installation](/guides/install-cli) and [authentication](/cli-reference/authentication). For a working application, follow the [quickstart](/quickstart). @@ -48,7 +48,7 @@ Choose a command below, then follow its subcommand links. Each page includes its ## Source and coverage -The command tree comes from the CLI's Clap definitions at revision `09bd402`, including both local and workspace modes. Hidden internal commands and Clap's automatically generated `help` routing aliases are excluded; every documented command supports `--help`. +The command tree comes from the CLI's Clap definitions at revision `1880d04`, including both local and workspace modes. Inside a workspace, some commands parse but refuse with a one-line message saying where they work; their pages say so. Hidden internal commands and Clap's automatically generated `help` routing aliases are excluded; every documented command supports `--help`. Syntax and flags are generated independently of maintained examples. Examples containing uppercase placeholders require your values. Commands that create, change, or delete resources perform those operations when run; `--help` is always offline. diff --git a/cli-reference/command-notes.json b/cli-reference/command-notes.json index 066391e..ec694b2 100644 --- a/cli-reference/command-notes.json +++ b/cli-reference/command-notes.json @@ -1,6 +1,6 @@ { "ai": { - "description": "Run this command on your local machine.", + "description": "Run this command in an authenticated local terminal or inside a workspace; see the availability above.", "examples": [ { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -9,12 +9,16 @@ ] }, "ai/defaults": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "With no flags, shows your account's default AI mode, provider, and model. Passing `--mode`, `--provider`, or `--model` changes only those fields. Inside a workspace the defaults can be read but not changed.", "examples": [ { - "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", + "description": "Show the current defaults.", "command": "rig ai defaults" }, + { + "description": "Change the default provider and model; the mode is left as it is.", + "command": "rig ai defaults --provider anthropic --model claude-sonnet-4-20250514" + }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", "command": "rig ai defaults --help" @@ -35,11 +39,15 @@ ] }, "api": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", - "command": "rig api GET /api/v1/workspaces" + "command": "rig api GET /v1/workspaces" + }, + { + "description": "Send an inline JSON body. Replace APP_ID with an app ID from `rig app ls`.", + "command": "rig api PATCH /v1/apps/APP_ID --body '{\"name\":\"web\"}'" }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -48,7 +56,7 @@ ] }, "api-key": { - "description": "Run this command on your local machine.", + "description": "Run this command on your local machine. Inside a workspace, `rig api-key` refuses with a one-line message; run it from your laptop.", "examples": [ { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -97,7 +105,7 @@ "warning": "This command deletes a resource. Confirm the identifier and preserve any data you need before running the example." }, "ci": { - "description": "Run this command on your local machine.", + "description": "Run this command on your local machine. Inside a workspace, `rig ci` refuses with a one-line message; run it from your laptop.", "examples": [ { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -159,7 +167,7 @@ ] }, "config": { - "description": "Run this command on your local machine.", + "description": "Run this command in an authenticated local terminal or inside a workspace; see the availability above.", "examples": [ { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -174,6 +182,10 @@ "description": "Use JSON output for subsequent commands.", "command": "rig config set output json" }, + { + "description": "Stop rig from setting up SSH access on this machine.", + "command": "rig config set ssh-setup false" + }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", "command": "rig config set --help" @@ -221,12 +233,16 @@ ] }, "completions": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { - "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", + "description": "Print the completion script for the shell you are using.", "command": "rig completions" }, + { + "description": "Install zsh completions without editing your shell configuration.", + "command": "rig completions zsh --install --no-rc" + }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", "command": "rig completions --help" @@ -247,7 +263,7 @@ ] }, "login": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Authenticate from your local terminal; complete browser approval.", @@ -260,7 +276,7 @@ ] }, "logout": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -295,7 +311,7 @@ ] }, "service-spec/create": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -308,7 +324,7 @@ ] }, "service-spec/update": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -321,7 +337,7 @@ ] }, "service-spec/rm": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -357,7 +373,7 @@ ] }, "setup-script/create": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -370,7 +386,7 @@ ] }, "setup-script/update": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -383,7 +399,7 @@ ] }, "setup-script/rm": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -397,7 +413,7 @@ "warning": "This command deletes a resource. Confirm the identifier and preserve any data you need before running the example." }, "ssh": { - "description": "Run this command on your local machine.", + "description": "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.", "examples": [ { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -419,11 +435,15 @@ ] }, "ssh/add": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { - "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", - "command": "rig ssh add --name my-project" + "description": "Register your default key, creating one if needed, and set up `ssh ` for your workspaces.", + "command": "rig ssh add" + }, + { + "description": "Register a specific public key under a name you choose.", + "command": "rig ssh add --name work-laptop --file ~/.ssh/work_ed25519.pub" }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -432,7 +452,7 @@ ] }, "ssh/rm": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal. Removes a registered key; pass the name or ID that `rig ssh ls` shows.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -472,7 +492,7 @@ ] }, "uninstall": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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`.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -486,12 +506,16 @@ "warning": "This command removes the local CLI installation. Review its flags before running it." }, "update": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { - "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", + "description": "Update to the latest release.", "command": "rig update" }, + { + "description": "Install a specific release instead of the latest. VERSION is a release tag such as `v0.12.68`; the leading `v` is optional.", + "command": "rig update --version VERSION" + }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", "command": "rig update --help" @@ -534,7 +558,7 @@ ] }, "app/new": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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`.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -547,7 +571,7 @@ ] }, "app/logs": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -560,7 +584,7 @@ ] }, "app/expose-port": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -862,12 +886,16 @@ "warning": "This command deletes a resource. Confirm the identifier and preserve any data you need before running the example." }, "init": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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`.", "examples": [ { "description": "From your application directory, scaffold rig.yaml and review it before deploying.", "command": "rig init" }, + { + "description": "Name the app and its port. This writes `name: my-app`.", + "command": "rig init --name \"My App\" --port 8080" + }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", "command": "rig init --help" @@ -938,7 +966,7 @@ "warning": "This command deletes a resource. Confirm the identifier and preserve any data you need before running the example." }, "volume": { - "description": "Run this command on your local machine.", + "description": "Run this command in an authenticated local terminal or inside a workspace; see the availability above.", "examples": [ { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -1001,7 +1029,7 @@ "warning": "This command deletes a resource. Confirm the identifier and preserve any data you need before running the example." }, "build": { - "description": "Run this command on your local machine.", + "description": "Run this command in an authenticated local terminal or inside a workspace; see the availability above.", "examples": [ { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -1049,7 +1077,7 @@ ] }, "release": { - "description": "Run this command on your local machine.", + "description": "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.", "examples": [ { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -1161,7 +1189,7 @@ "warning": "This command changes an existing resource or its configuration and may affect a running application. Confirm the target and review the complete help before running the example." }, "rollback": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1184,7 +1212,7 @@ ] }, "tools/ls": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1197,11 +1225,11 @@ ] }, "tools/launch": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", - "command": "rig tools launch --tool TOOL --workspace WORKSPACE_ID" + "command": "rig tools launch --tool virtual-browser --workspace WORKSPACE_ID" }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -1224,11 +1252,11 @@ "warning": "This command changes an existing resource or its configuration and may affect a running application. Confirm the target and review the complete help before running the example." }, "tools/install": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", - "command": "rig tools install --workspace WORKSPACE_ID --tool TOOL" + "command": "rig tools install --workspace WORKSPACE_ID --tool architecture" }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", @@ -1250,7 +1278,7 @@ ] }, "deploy": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Deploy the project from the local directory containing rig.yaml. Review the deployment strategy before running.", @@ -1298,7 +1326,7 @@ ] }, "workspace/spawn": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Create a development workspace from your local machine.", @@ -1311,7 +1339,7 @@ ] }, "workspace/new": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1324,7 +1352,7 @@ ] }, "workspace/rm": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1338,7 +1366,7 @@ "warning": "This command deletes a resource. Confirm the identifier and preserve any data you need before running the example." }, "workspace/cancel": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1352,7 +1380,7 @@ "warning": "This command changes an existing resource or its configuration and may affect a running application. Confirm the target and review the complete help before running the example." }, "workspace/retry": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1365,7 +1393,7 @@ ] }, "workspace/restart": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1379,7 +1407,7 @@ "warning": "This command changes an existing resource or its configuration and may affect a running application. Confirm the target and review the complete help before running the example." }, "workspace/start": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1392,7 +1420,7 @@ ] }, "workspace/stop": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal. Inside a workspace, this command refuses with a one-line message: workspace lifecycle runs from your laptop.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1406,7 +1434,7 @@ "warning": "This command changes an existing resource or its configuration and may affect a running application. Confirm the target and review the complete help before running the example." }, "workspace/logs": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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`.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1419,12 +1447,16 @@ ] }, "workspace/ssh-info": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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`.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", "command": "rig workspace ssh-info --workspace WORKSPACE_ID" }, + { + "description": "Print the details as JSON for scripts; `ssh_target` is always present and `ssh_alias` appears once SSH access is set up.", + "command": "rig workspace ssh-info --workspace WORKSPACE_ID --output json" + }, { "description": "Inspect the supported arguments before running this command. Help is offline and does not modify resources.", "command": "rig workspace ssh-info --help" @@ -1529,7 +1561,7 @@ ] }, "workspace/metrics": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1542,7 +1574,7 @@ ] }, "workspace/services": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1555,7 +1587,7 @@ ] }, "workspace/ports": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1568,7 +1600,7 @@ ] }, "workspace/resize": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1582,7 +1614,7 @@ "warning": "This command changes an existing resource or its configuration and may affect a running application. Confirm the target and review the complete help before running the example." }, "workspace/reconcile": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "Use this command from your local terminal or inside a workspace. Inside a workspace, `--workspace` defaults to that workspace.", "examples": [ { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", @@ -1679,8 +1711,12 @@ ] }, "recipe/app/install": { - "description": "Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.", + "description": "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`.", "examples": [ + { + "description": "Add Claude Code to an existing workspace.", + "command": "rig recipe app install --ref claude --workspace WORKSPACE_ID" + }, { "description": "Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", "command": "rig recipe app install --ref DEPLOY_REF --workspace WORKSPACE_ID" @@ -1821,7 +1857,7 @@ ] }, "proxy/off": { - "description": "Use this command inside a workspace.", + "description": "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`.", "examples": [ { "description": "Run inside a workspace. Replace uppercase placeholders with your own values. This invocation performs the operation described above.", diff --git a/cli-reference/command-surface.json b/cli-reference/command-surface.json index 9c5876a..9c37956 100644 --- a/cli-reference/command-surface.json +++ b/cli-reference/command-surface.json @@ -410,14 +410,14 @@ } ], "groups": [], - "help": "Configure account-level AI defaults and view usage\n\nUsage: rigbox ai [OPTIONS] \n\nCommands:\n defaults Update account-level AI defaults\n usage Show AI usage history\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": "Configure account-level AI defaults and view usage\n\nUsage: rigbox ai [OPTIONS] \n\nCommands:\n defaults Show account-level AI defaults, or update them with any flag\n usage Show AI usage history\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": [ "ai" ], "usage": "Usage: rigbox ai [OPTIONS] " }, { - "about": "Update account-level AI defaults", + "about": "Show account-level AI defaults, or update them with any flag", "aliases": [], "arguments": [ { @@ -678,7 +678,7 @@ "required": false } ], - "help": "Update account-level AI defaults\n\nUsage: rigbox ai defaults [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 -p, --provider \n Default provider: google, openai, or anthropic\n\n -m, --model \n Default model id (e.g. claude-sonnet-4-20250514)\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 --mode \n Default AI mode: managed or byok\n \n [possible values: managed, byok]\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 account-level AI defaults, or update them with any flag\n\nUsage: rigbox ai defaults [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 -p, --provider \n Default provider: google, openai, or anthropic\n\n -m, --model \n Default model id (e.g. claude-sonnet-4-20250514)\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 --mode \n Default AI mode: managed or byok\n \n [possible values: managed, byok]\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": [ "ai", "defaults" @@ -930,7 +930,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Request body as JSON from a file or '-' for stdin (non-GET)", + "help": "Request body (non-GET): inline JSON such as '{\"name\":\"web\"}', a JSON file path, or '-' for stdin", "id": "body", "long": "body", "num_args": { @@ -941,7 +941,7 @@ "short": null, "short_aliases": [], "value_names": [ - "FILE" + "JSON|FILE" ], "values": [] }, @@ -1137,7 +1137,7 @@ "required": false } ], - "help": "Send a raw authenticated request to the Rigbox API\n\nUsage: rigbox api [OPTIONS] \n\nArguments:\n \n HTTP method (GET, POST, PUT, PATCH, DELETE)\n\n \n API path, e.g. /v1/workspaces\n\nOptions:\n --body \n Request body as JSON from a file or '-' for stdin (non-GET)\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 --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": "Send a raw authenticated request to the Rigbox API\n\nUsage: rigbox api [OPTIONS] \n\nArguments:\n \n HTTP method (GET, POST, PUT, PATCH, DELETE)\n\n \n API path, e.g. /v1/workspaces\n\nOptions:\n --body \n Request body (non-GET): inline JSON such as '{\"name\":\"web\"}', a JSON file path, or '-' for stdin\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 --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": [ "api" ], @@ -7502,7 +7502,7 @@ } ], "groups": [], - "help": "Manage SSH public keys for your account\n\nUsage: rigbox ssh [OPTIONS] \n\nCommands:\n ls List registered SSH public keys\n add Register a new SSH public key\n rm Remove a registered SSH public key\n sync Push your SSH keys into a workspace\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 SSH public keys for your account\n\nUsage: rigbox ssh [OPTIONS] \n\nCommands:\n ls List registered SSH public keys\n add Register an SSH public key and set up `ssh ` on this machine\n rm Remove a registered SSH public key\n sync Push your SSH keys into a workspace\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": [ "ssh" ], @@ -7731,7 +7731,7 @@ "usage": "Usage: rigbox ssh ls [OPTIONS]" }, { - "about": "Register a new SSH public key", + "about": "Register an SSH public key and set up `ssh ` on this machine", "aliases": [], "arguments": [ { @@ -7740,14 +7740,14 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Key name", + "help": "Key name (default: laptop-)", "id": "name", "long": "name", "num_args": { "max": 1, "min": 1 }, - "required": true, + "required": false, "short": "n", "short_aliases": [], "value_names": [ @@ -7761,7 +7761,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Path to public key file (default: ~/.ssh/id_ed25519.pub)", + "help": "Path to public key file (default: ~/.ssh/id_ed25519.pub, created if you have no key)", "id": "file", "long": "file", "num_args": { @@ -7967,12 +7967,12 @@ "required": false } ], - "help": "Register a new SSH public key\n\nUsage: rigbox ssh add [OPTIONS] --name \n\nOptions:\n -n, --name \n Key name\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 -f, --file \n Path to public key file (default: ~/.ssh/id_ed25519.pub)\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": "Register an SSH public key and set up `ssh ` on this machine\n\nUsage: rigbox ssh add [OPTIONS]\n\nOptions:\n -n, --name \n Key name (default: laptop-)\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 -f, --file \n Path to public key file (default: ~/.ssh/id_ed25519.pub, created if you have no key)\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": [ "ssh", "add" ], - "usage": "Usage: rigbox ssh add [OPTIONS] --name " + "usage": "Usage: rigbox ssh add [OPTIONS]" }, { "about": "Remove a registered SSH public key", @@ -7986,7 +7986,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Key name", + "help": "Key name or id (see `rig ssh ls`)", "id": "name", "long": "name", "num_args": { @@ -8191,7 +8191,7 @@ "required": false } ], - "help": "Remove a registered SSH public key\n\nUsage: rigbox ssh rm [OPTIONS] --name \n\nOptions:\n -n, --name \n Key name\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 --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": "Remove a registered SSH public key\n\nUsage: rigbox ssh rm [OPTIONS] --name \n\nOptions:\n -n, --name \n Key name or id (see `rig ssh ls`)\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 --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": [ "ssh", "rm" @@ -9987,7 +9987,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -10240,7 +10240,7 @@ "required": false } ], - "help": "View app logs\n\nUsage: rigbox app logs [OPTIONS] --app \n\nOptions:\n -a, --app \n App name or id\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 -f, --follow\n Follow logs in real time\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 --install\n Show the app's install logs (the rigbox-install- unit) instead of runtime logs. Works for CLI agents and failed/stopped apps\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": "View app logs\n\nUsage: rigbox app logs [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 -f, --follow\n Follow logs in real time\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 --install\n Show the app's install logs (the rigbox-install- unit) instead of runtime logs. Works for CLI agents and failed/stopped apps\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": [ "app", "logs" @@ -10547,7 +10547,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -10752,7 +10752,7 @@ "required": false } ], - "help": "Start an app\n\nUsage: rigbox app start [OPTIONS] --app \n\nOptions:\n -a, --app \n App name or id\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 --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": "Start an app\n\nUsage: rigbox app start [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "start" @@ -10769,7 +10769,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -10974,7 +10974,7 @@ "required": false } ], - "help": "Stop an app\n\nUsage: rigbox app stop [OPTIONS] --app \n\nOptions:\n -a, --app \n App name or id\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 --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": "Stop an app\n\nUsage: rigbox app stop [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "stop" @@ -10991,7 +10991,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -11196,7 +11196,7 @@ "required": false } ], - "help": "Restart an app\n\nUsage: rigbox app restart [OPTIONS] --app \n\nOptions:\n -a, --app \n App name or id\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 --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": "Restart an app\n\nUsage: rigbox app restart [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "restart" @@ -11213,7 +11213,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -11488,7 +11488,7 @@ "required": false } ], - "help": "Delete an app\n\nUsage: rigbox app rm [OPTIONS] --app \n\nOptions:\n -a, --app \n App name or id\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 --query \n Filter output with a JMESPath expression\n\n -w, --workspace \n Workspace to narrow app name matches\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --force\n Confirm deletion of system-managed apps\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --force-delete\n Confirm deletion of apps containing user-modifiable files\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": "Delete an app\n\nUsage: rigbox app rm [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --query \n Filter output with a JMESPath expression\n\n -w, --workspace \n Workspace to narrow app name matches\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --force\n Confirm deletion of system-managed apps\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --force-delete\n Confirm deletion of apps containing user-modifiable files\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": [ "app", "rm" @@ -11505,7 +11505,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App id, name, or subdomain", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -11789,7 +11789,7 @@ "required": false } ], - "help": "Set app visibility (public, private, or emails)\n\nPick exactly one mode: --public visible to everyone --private visible only to you --emails a,b,c allowlist of specific emails\n\nUsage: rigbox app share [OPTIONS] --app \n\nOptions:\n -a, --app \n App id, name, or subdomain\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 --public\n Make the app public (visible to everyone)\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 --private\n Make the app private (visible only to you)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --emails \n Share with these emails (comma-separated). Implies allowlist visibility\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 (see a summary with '-h')\n", + "help": "Set app visibility (public, private, or emails)\n\nPick exactly one mode: --public visible to everyone --private visible only to you --emails a,b,c allowlist of specific emails\n\nUsage: rigbox app share [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --public\n Make the app public (visible to everyone)\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 --private\n Make the app private (visible only to you)\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --emails \n Share with these emails (comma-separated). Implies allowlist visibility\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 (see a summary with '-h')\n", "path": [ "app", "share" @@ -11806,7 +11806,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App id, name, or subdomain", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -12011,7 +12011,7 @@ "required": false } ], - "help": "Show app runtime health\n\nUsage: rigbox app health [OPTIONS] --app \n\nOptions:\n -a, --app \n App id, name, or subdomain\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 --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 app runtime health\n\nUsage: rigbox app health [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "health" @@ -12028,7 +12028,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App id, name, or subdomain", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -12233,7 +12233,7 @@ "required": false } ], - "help": "Re-check DNS for an app custom domain\n\nUsage: rigbox app verify-domain [OPTIONS] --app \n\nOptions:\n -a, --app \n App id, name, or subdomain\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 --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": "Re-check DNS for an app custom domain\n\nUsage: rigbox app verify-domain [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "verify-domain" @@ -12443,7 +12443,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App id, name, or subdomain", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -12670,7 +12670,7 @@ "required": false } ], - "help": "Set a custom domain for an app\n\nUsage: rigbox app domain set [OPTIONS] --app --domain \n\nOptions:\n -a, --app \n App id, name, or subdomain\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 -d, --domain \n Domain to attach (e.g. app.example.com)\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": "Set a custom domain for an app\n\nUsage: rigbox app domain set [OPTIONS] --app --domain \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 -d, --domain \n Domain to attach (e.g. app.example.com)\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": [ "app", "domain", @@ -12881,7 +12881,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name, id, or exact subdomain", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -13108,7 +13108,7 @@ "required": false } ], - "help": "Set app environment variables (preserves other keys; rig.yaml overrides on deploy)\n\nUsage: rigbox app env set [OPTIONS] --app ...\n\nArguments:\n ...\n Environment assignments (KEY=value); restart the app to apply\n\nOptions:\n -a, --app \n App name, id, or exact subdomain\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 --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": "Set app environment variables (preserves other keys; rig.yaml overrides on deploy)\n\nUsage: rigbox app env set [OPTIONS] --app ...\n\nArguments:\n ...\n Environment assignments (KEY=value); restart the app to apply\n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "env", @@ -13126,7 +13126,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name, id, or exact subdomain", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -13353,7 +13353,7 @@ "required": false } ], - "help": "Unset app environment variables (restart the app to apply)\n\nUsage: rigbox app env unset [OPTIONS] --app ...\n\nArguments:\n ...\n Environment variable names to remove\n\nOptions:\n -a, --app \n App name, id, or exact subdomain\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 --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": "Unset app environment variables (restart the app to apply)\n\nUsage: rigbox app env unset [OPTIONS] --app ...\n\nArguments:\n ...\n Environment variable names to remove\n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "env", @@ -13373,7 +13373,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -13602,7 +13602,7 @@ "required": false } ], - "help": "List app environment variables\n\nUsage: rigbox app env ls [OPTIONS] --app \n\nOptions:\n -a, --app \n App name or id\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 --query \n Filter output with a JMESPath expression\n\n -r, --reveal\n Show secret values in plaintext\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": "List app environment variables\n\nUsage: rigbox app env ls [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --query \n Filter output with a JMESPath expression\n\n -r, --reveal\n Show secret values in plaintext\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": [ "app", "env", @@ -13813,7 +13813,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -14018,7 +14018,7 @@ "required": false } ], - "help": "List all declared parameters and their current values\n\nUsage: rigbox app param ls [OPTIONS] --app \n\nOptions:\n -a, --app \n App name or id\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 --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": "List all declared parameters and their current values\n\nUsage: rigbox app param ls [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "param", @@ -14036,7 +14036,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -14263,7 +14263,7 @@ "required": false } ], - "help": "Read a single parameter value\n\nUsage: rigbox app param get [OPTIONS] --app \n\nArguments:\n \n Parameter key\n\nOptions:\n -a, --app \n App name or id\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 --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": "Read a single parameter value\n\nUsage: rigbox app param get [OPTIONS] --app \n\nArguments:\n \n Parameter key\n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "param", @@ -14281,7 +14281,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -14508,7 +14508,7 @@ "required": false } ], - "help": "Set one or more parameter values\n\nUsage: rigbox app param set [OPTIONS] --app ...\n\nArguments:\n ...\n One or more `KEY=VALUE` pairs (positional, repeatable)\n\nOptions:\n -a, --app \n App name or id\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 --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": "Set one or more parameter values\n\nUsage: rigbox app param set [OPTIONS] --app ...\n\nArguments:\n ...\n One or more `KEY=VALUE` pairs (positional, repeatable)\n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "param", @@ -14526,7 +14526,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -14753,7 +14753,7 @@ "required": false } ], - "help": "Reset parameters to their defaults\n\nUsage: rigbox app param unset [OPTIONS] --app ...\n\nArguments:\n ...\n One or more keys to clear (positional, repeatable)\n\nOptions:\n -a, --app \n App name or id\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 --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": "Reset parameters to their defaults\n\nUsage: rigbox app param unset [OPTIONS] --app ...\n\nArguments:\n ...\n One or more keys to clear (positional, repeatable)\n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "param", @@ -14964,7 +14964,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -15169,7 +15169,7 @@ "required": false } ], - "help": "List log sources for an app\n\nUsage: rigbox app log-source ls [OPTIONS] --app \n\nOptions:\n -a, --app \n App name or id\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 --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": "List log sources for an app\n\nUsage: rigbox app log-source ls [OPTIONS] --app \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --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": [ "app", "log-source", @@ -15187,7 +15187,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -15486,7 +15486,7 @@ "required": false } ], - "help": "Add a log source to an app\n\nUsage: rigbox app log-source add [OPTIONS] --app --type --ref \n\nOptions:\n -a, --app \n App name or id\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 --query \n Filter output with a JMESPath expression\n\n --type \n Source type: systemd_unit, docker_container, or file_path\n \n [possible values: systemd_unit, docker_container, file_path]\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --ref \n Unit name, container name, or absolute file path\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n -n, --name \n Display name shown in log views\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --primary\n Mark this source as primary (default = false)\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": "Add a log source to an app\n\nUsage: rigbox app log-source add [OPTIONS] --app --type --ref \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --query \n Filter output with a JMESPath expression\n\n --type \n Source type: systemd_unit, docker_container, or file_path\n \n [possible values: systemd_unit, docker_container, file_path]\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --ref \n Unit name, container name, or absolute file path\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n -n, --name \n Display name shown in log views\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n --primary\n Mark this source as primary (default = false)\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": [ "app", "log-source", @@ -15504,7 +15504,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -15853,7 +15853,7 @@ "required": false } ], - "help": "Update an app log source\n\nUsage: rigbox app log-source update [OPTIONS] --app --source \n\nOptions:\n -a, --app \n App name or id\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 --query \n Filter output with a JMESPath expression\n\n --source \n Log source id (from `rig app log-source ls`)\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --type \n Replace the source type\n \n [possible values: systemd_unit, docker_container, file_path]\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --ref \n Replace the source ref (unit, container, or file path)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n -n, --name \n Replace the display name\n\n --no-pager\n Do not pipe help output through a pager\n\n --primary\n Mark as primary\n\n --not-primary\n Mark as non-primary\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": "Update an app log source\n\nUsage: rigbox app log-source update [OPTIONS] --app --source \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --query \n Filter output with a JMESPath expression\n\n --source \n Log source id (from `rig app log-source ls`)\n\n --cli-input-json \n Read inputs from a JSON file or '-' (stdin)\n\n --type \n Replace the source type\n \n [possible values: systemd_unit, docker_container, file_path]\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --ref \n Replace the source ref (unit, container, or file path)\n\n --generate-cli-skeleton\n Print a fillable input template, then exit\n\n -n, --name \n Replace the display name\n\n --no-pager\n Do not pipe help output through a pager\n\n --primary\n Mark as primary\n\n --not-primary\n Mark as non-primary\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": [ "app", "log-source", @@ -15871,7 +15871,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "App name or id", + "help": "App name, id, or subdomain", "id": "app", "long": "app", "num_args": { @@ -16098,7 +16098,7 @@ "required": false } ], - "help": "Remove an app log source\n\nUsage: rigbox app log-source rm [OPTIONS] --app --source \n\nOptions:\n -a, --app \n App name or id\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 --query \n Filter output with a JMESPath expression\n\n --source \n Log source id (from `rig app log-source ls`)\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": "Remove an app log source\n\nUsage: rigbox app log-source rm [OPTIONS] --app --source \n\nOptions:\n -a, --app \n App name, id, or subdomain\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 --query \n Filter output with a JMESPath expression\n\n --source \n Log source id (from `rig app log-source ls`)\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": [ "app", "log-source", @@ -16137,7 +16137,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Override the app name (defaults to the directory name)", + "help": "Override the app name (defaults to the directory name); converted to lowercase letters, digits and dashes", "id": "name", "long": "name", "num_args": { @@ -16160,7 +16160,7 @@ "3000" ], "global": false, - "help": "Port to expose [default: 3000]", + "help": "Port to expose", "id": "port", "long": "port", "num_args": { @@ -16391,7 +16391,7 @@ "required": false } ], - "help": "Scaffold a rig.yaml for the current directory\n\nUsage: rigbox init [OPTIONS]\n\nOptions:\n --from \n Directory to scaffold (defaults to current directory)\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, --name \n Override the app name (defaults to the directory name)\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 -p, --port \n Port to expose [default: 3000]\n \n [default: 3000]\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --force\n Overwrite an existing rig.yaml\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": "Scaffold a rig.yaml for the current directory\n\nUsage: rigbox init [OPTIONS]\n\nOptions:\n --from \n Directory to scaffold (defaults to current directory)\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, --name \n Override the app name (defaults to the directory name); converted to lowercase letters, digits and dashes\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 -p, --port \n Port to expose\n \n [default: 3000]\n\n --cli-input-yaml \n Read inputs from a YAML file or '-' (stdin)\n\n --force\n Overwrite an existing rig.yaml\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": [ "init" ], @@ -22206,14 +22206,14 @@ } ], "groups": [], - "help": "Launch and manage workspace tools\n\nUsage: rigbox tools [OPTIONS] \n\nCommands:\n ls List tools running in a workspace\n launch Launch a tool\n stop Stop a tool\n install Install a tool into a workspace (async)\n install-status Poll the status of an async tool install\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": "Launch and manage workspace tools\n\nUsage: rigbox tools [OPTIONS] \n\nCommands:\n ls List workspace tools with their status and URL\n launch Launch a tool\n stop Stop a tool\n install Install a tool into a workspace (async)\n install-status Poll the status of an async tool install\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": [ "tools" ], "usage": "Usage: rigbox tools [OPTIONS] " }, { - "about": "List tools running in a workspace", + "about": "List workspace tools with their status and URL", "aliases": [], "arguments": [ { @@ -22427,7 +22427,7 @@ "required": false } ], - "help": "List tools running in a workspace\n\nUsage: rigbox tools ls [OPTIONS] --workspace \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 -w, --workspace \n Workspace name or id\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": "List workspace tools with their status and URL\n\nUsage: rigbox tools ls [OPTIONS] --workspace \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 -w, --workspace \n Workspace name or id\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": [ "tools", "ls" @@ -22444,7 +22444,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Tool id (e.g. architecture-explorer, virtual-browser)", + "help": "Tool id (e.g. architecture, virtual-browser)", "id": "tool", "long": "tool", "num_args": { @@ -22671,7 +22671,7 @@ "required": false } ], - "help": "Launch a tool\n\nUsage: rigbox tools launch [OPTIONS] --tool --workspace \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 -t, --tool \n Tool id (e.g. architecture-explorer, virtual-browser)\n\n --query \n Filter output with a JMESPath expression\n\n -w, --workspace \n Workspace name or id\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": "Launch a tool\n\nUsage: rigbox tools launch [OPTIONS] --tool --workspace \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 -t, --tool \n Tool id (e.g. architecture, virtual-browser)\n\n --query \n Filter output with a JMESPath expression\n\n -w, --workspace \n Workspace name or id\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": [ "tools", "launch" @@ -22953,7 +22953,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Tool id (e.g. architecture-explorer, virtual-browser)", + "help": "Tool id (e.g. architecture, virtual-browser)", "id": "tool", "long": "tool", "num_args": { @@ -23159,7 +23159,7 @@ "required": false } ], - "help": "Install a tool into a workspace (async)\n\nUsage: rigbox tools install [OPTIONS] --workspace --tool \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 -w, --workspace \n Workspace name or id\n\n --query \n Filter output with a JMESPath expression\n\n -t, --tool \n Tool id (e.g. architecture-explorer, virtual-browser)\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": "Install a tool into a workspace (async)\n\nUsage: rigbox tools install [OPTIONS] --workspace --tool \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 -w, --workspace \n Workspace name or id\n\n --query \n Filter output with a JMESPath expression\n\n -t, --tool \n Tool id (e.g. architecture, virtual-browser)\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": [ "tools", "install" @@ -24745,7 +24745,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Template id (e.g. base, dev, ai-agent-starter)", + "help": "Template id (e.g. base, dev, custom-repo)", "id": "template", "long": "template", "num_args": { @@ -24829,7 +24829,7 @@ "conflicts": [], "defaults": [], "global": false, - "help": "Catalog recipe id to install at first boot (repeatable)", + "help": "Catalog recipe id to install at first boot (repeatable); to add one to an existing workspace, use `rig recipe app install --ref `", "id": "catalog", "long": "catalog", "num_args": { @@ -25175,7 +25175,7 @@ "required": false } ], - "help": "Create and start a workspace in one step\n\nUsage: rigbox workspace spawn [OPTIONS] --name \n\nOptions:\n -n, --name \n Workspace name\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 --query \n Filter output with a JMESPath expression\n\n -t, --template