> ## Documentation Index > Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt > Use this file to discover all available pages before exploring further. # rig workspace > Manage workspace lifecycle and configuration Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Run this command in an authenticated local terminal or inside a workspace; see the availability above. ## Examples Inspect the supported arguments before running this command. Help is offline and does not modify resources. ```bash theme={null} rig workspace --help ``` ## Local syntax ```text theme={null} Usage: rigbox workspace [OPTIONS] ``` ### Arguments and flags | Argument | Description | Details | | - | - | - | | `--output` | Output format \[default: human, or `rig config set output …`] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table | | `--query` | Filter output with a JMESPath expression | Global; Value: JMESPATH | | `--cli-input-json` | Read inputs from a JSON file or '-' (stdin) | Global; Value: FILE | | `--cli-input-yaml` | Read inputs from a YAML file or '-' (stdin) | Global; Value: FILE; Conflicts: cli\_input\_json | | `--generate-cli-skeleton` | Print a fillable input template, then exit | Global; Default: false | | `--no-pager` | Do not pipe help output through a pager | Global; Default: false | | `-v, --verbose` | Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy` | Global; Default: false | | `-h, --help` | Print help | | > **Complete command help** > > ```text theme={null} > Manage workspace lifecycle and configuration > > Usage: rigbox workspace [OPTIONS] > > Commands: > ls List all workspaces in your account > spawn Create and start a workspace in one step > new Create a new workspace without starting it > rm Delete a workspace > cancel Cancel an in-progress workspace creation > retry Retry a workspace that failed during creation > restart Restart a workspace > start Start a workspace > stop Stop a workspace > logs View workspace logs > ssh-info Print SSH connection info for a workspace > env Manage workspace environment variables > ai Manage workspace AI configuration > metrics Show live CPU, RAM, and disk metrics > services List background services tracked in the workspace > ports List ports the workspace is currently listening on > resize Resize workspace resources > reconcile Reconcile workspace apps with the template > help Print this message or the help of the given subcommand(s) > > Options: > --output > Output format [default: human, or `rig config set output …`] > > [possible values: human, json, yaml, text, table] > > --query > Filter output with a JMESPath expression > > --cli-input-json > Read inputs from a JSON file or '-' (stdin) > > --cli-input-yaml > Read inputs from a YAML file or '-' (stdin) > > --generate-cli-skeleton > Print a fillable input template, then exit > > --no-pager > Do not pipe help output through a pager > > -v, --verbose > Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy` > > -h, --help > Print help > ``` ## Workspace syntax ```text theme={null} Usage: rigbox workspace [OPTIONS] ``` ### Arguments and flags | Argument | Description | Details | | - | - | - | | `--output` | Output format \[default: human, or `rig config set output …`] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table | | `--query` | Filter output with a JMESPath expression | Global; Value: JMESPATH | | `--no-pager` | Do not pipe help output through a pager | Global; Default: false | | `-v, --verbose` | Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status) | Global; Default: false | | `-h, --help` | Print help | | > **Complete command help** > > ```text theme={null} > Manage this workspace's config and logs > > Usage: rigbox workspace [OPTIONS] > > Commands: > ai Manage workspace AI configuration > cancel Cancel an in-progress workspace creation > env Manage workspace environment variables > logs View this workspace's logs > ls List all workspaces in your account > metrics Show live CPU, RAM, and disk metrics > new Create a new workspace without starting it > ports List ports the workspace is currently listening on > reconcile Reconcile workspace apps with the template > resize Resize workspace resources > restart Restart a workspace > retry Retry a workspace that failed during creation > rm Delete a workspace > services List background services tracked in the workspace > spawn Create and start a workspace in one step > ssh-info Print this workspace's SSH connection info > start Start a workspace > stop Stop a workspace > help Print this message or the help of the given subcommand(s) > > Options: > --output > Output format [default: human, or `rig config set output …`] > > [possible values: human, json, yaml, text, table] > > --query > Filter output with a JMESPath expression > > --no-pager > Do not pipe help output through a pager > > -v, --verbose > Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status) > > -h, --help > Print help > ``` ## Subcommands * [ai](https://docs.rigbox.dev/cli-reference/commands/workspace/ai) * [cancel](https://docs.rigbox.dev/cli-reference/commands/workspace/cancel) * [env](https://docs.rigbox.dev/cli-reference/commands/workspace/env) * [logs](https://docs.rigbox.dev/cli-reference/commands/workspace/logs) * [ls](https://docs.rigbox.dev/cli-reference/commands/workspace/ls) * [metrics](https://docs.rigbox.dev/cli-reference/commands/workspace/metrics) * [new](https://docs.rigbox.dev/cli-reference/commands/workspace/new) * [ports](https://docs.rigbox.dev/cli-reference/commands/workspace/ports) * [reconcile](https://docs.rigbox.dev/cli-reference/commands/workspace/reconcile) * [resize](https://docs.rigbox.dev/cli-reference/commands/workspace/resize) * [restart](https://docs.rigbox.dev/cli-reference/commands/workspace/restart) * [retry](https://docs.rigbox.dev/cli-reference/commands/workspace/retry) * [rm](https://docs.rigbox.dev/cli-reference/commands/workspace/rm) * [services](https://docs.rigbox.dev/cli-reference/commands/workspace/services) * [spawn](https://docs.rigbox.dev/cli-reference/commands/workspace/spawn) * [ssh-info](https://docs.rigbox.dev/cli-reference/commands/workspace/ssh-info) * [start](https://docs.rigbox.dev/cli-reference/commands/workspace/start) * [stop](https://docs.rigbox.dev/cli-reference/commands/workspace/stop) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.