> ## 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 recipe app install > Install an exact recipe ref into a workspace Available **local and workspace**. Reference source: CLI `0.13.0-rc.5` (`824aefd6ad16`). Installs a recipe into an existing workspace. `--ref` takes an exact recipe ref such as `@vendor/slug@1.2.3`, or a built-in catalog ID such as `claude` to add a catalog app or coding agent. The command starts the install and returns. Inside a workspace, pass that workspace's own name or ID to `--workspace`. ## Examples Add Claude Code to an existing workspace. ```bash theme={null} rig recipe app install --ref claude --workspace WORKSPACE_ID ``` Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above. ```bash theme={null} rig recipe app install --ref DEPLOY_REF --workspace WORKSPACE_ID ``` Inspect the supported arguments before running this command. Help is offline and does not modify resources. ```bash theme={null} rig recipe app install --help ``` ## Local syntax ```text theme={null} Usage: rigbox recipe app install [OPTIONS] --ref --workspace ``` ### Arguments and flags | Argument | Description | Details | | - | - | - | | `-r, --ref` | Recipe ref to install: an exact @vendor/slug\@1.2.3, or a built-in catalog id such as claude | Required; Value: DEPLOY\_REF | | `-w, --workspace` | Workspace name or id | Required; Value: WORKSPACE | | `--param` | Recipe parameter in `key=value` form (repeatable) | Value: PARAMS | | `--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 (see a summary with '-h') | | > **Complete command help** > > ```text theme={null} > Install an exact recipe ref into a workspace > > Also adds a built-in catalog app, such as a coding agent (claude, codex, opencode, …), to an existing workspace: pass its catalog id as the ref, e.g. `rig recipe app install --ref claude --workspace my-ws`. `rig workspace spawn --catalog` installs catalog apps only while creating a workspace. > > Usage: rigbox recipe app install [OPTIONS] --ref --workspace > > Options: > --output > Output format [default: human, or `rig config set output …`] > > [possible values: human, json, yaml, text, table] > > -r, --ref > Recipe ref to install: an exact @vendor/slug@1.2.3, or a built-in catalog id such as claude > > --query > Filter output with a JMESPath expression > > -w, --workspace > Workspace name or id > > --cli-input-json > Read inputs from a JSON file or '-' (stdin) > > --param > Recipe parameter in `key=value` form (repeatable) > > --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 (see a summary with '-h') > ``` ## Workspace syntax ```text theme={null} Usage: rigbox recipe app install [OPTIONS] --ref --workspace ``` ### Arguments and flags | Argument | Description | Details | | - | - | - | | `-r, --ref` | Recipe ref to install: an exact @vendor/slug\@1.2.3, or a built-in catalog id such as claude | Required; Value: DEPLOY\_REF | | `-w, --workspace` | Workspace name or id | Required; Value: WORKSPACE | | `--param` | Recipe parameter in `key=value` form (repeatable) | Value: PARAMS | | `--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 (see a summary with '-h') | | > **Complete command help** > > ```text theme={null} > Install an exact recipe ref into a workspace > > Also adds a built-in catalog app, such as a coding agent (claude, codex, opencode, …), to an existing workspace: pass its catalog id as the ref, e.g. `rig recipe app install --ref claude --workspace my-ws`. `rig workspace spawn --catalog` installs catalog apps only while creating a workspace. > > Usage: rigbox recipe app install [OPTIONS] --ref --workspace > > Options: > --output > Output format [default: human, or `rig config set output …`] > > [possible values: human, json, yaml, text, table] > > -r, --ref > Recipe ref to install: an exact @vendor/slug@1.2.3, or a built-in catalog id such as claude > > --query > Filter output with a JMESPath expression > > -w, --workspace > Workspace name or id > > --no-pager > Do not pipe help output through a pager > > --param > Recipe parameter in `key=value` form (repeatable) > > -v, --verbose > Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status) > > -h, --help > Print help (see a summary with '-h') > ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.