> ## 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 tools launch

> Launch a tool

Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`).

Starts a tool: `architecture` (Architecture Explorer) or `virtual-browser`. The command fails when the server launches nothing. While the tool is still starting, `rig tools ls` shows its status and, once it serves, its URL.

## Examples

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

```bash theme={null}
rig tools launch --tool virtual-browser --workspace WORKSPACE_ID
```

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

```bash theme={null}
rig tools launch --help
```

## Local syntax

```text theme={null}
Usage: rigbox tools launch [OPTIONS] --tool <TOOL> --workspace <WORKSPACE>
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `-t, --tool` | Tool id (e.g. architecture, virtual-browser) | Required; Value: TOOL |
| `-w, --workspace` | Workspace name or id | Required; Value: WORKSPACE |
| `--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}
> Launch a tool
>
> Usage: rigbox tools launch [OPTIONS] --tool <TOOL> --workspace <WORKSPACE>
>
> Options:
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>   -t, --tool <TOOL>
>           Tool id (e.g. architecture, virtual-browser)
>
>       --query <JMESPATH>
>           Filter output with a JMESPath expression
>
>   -w, --workspace <WORKSPACE>
>           Workspace name or id
>
>       --cli-input-json <FILE>
>           Read inputs from a JSON file or '-' (stdin)
>
>       --cli-input-yaml <FILE>
>           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 tools launch [OPTIONS] --tool <TOOL> --workspace <WORKSPACE>
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `-t, --tool` | Tool id (e.g. architecture, virtual-browser) | Required; Value: TOOL |
| `-w, --workspace` | Workspace name or id | Required; Value: WORKSPACE |
| `--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}
> Launch a tool
>
> Usage: rigbox tools launch [OPTIONS] --tool <TOOL> --workspace <WORKSPACE>
>
> Options:
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>   -t, --tool <TOOL>
>           Tool id (e.g. architecture, virtual-browser)
>
>       --query <JMESPATH>
>           Filter output with a JMESPath expression
>
>   -w, --workspace <WORKSPACE>
>           Workspace name or id
>
>       --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
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.