> ## 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 completions

> Generate or install a shell completion script

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

Prints a completion script for your shell, or installs it with `--install`. `--no-rc` only works with `--install`: it installs the script and prints the lines to add to your shell configuration instead of editing it. Works in your local terminal and inside a workspace.

## Examples

Print the completion script for the shell you are using.

```bash theme={null}
rig completions
```

Install zsh completions without editing your shell configuration.

```bash theme={null}
rig completions zsh --install --no-rc
```

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

```bash theme={null}
rig completions --help
```

## Local syntax

```text theme={null}
Usage: rigbox completions [OPTIONS] [SHELL]
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `shell` | Shell to target (auto-detected from the invoking shell when omitted) | Value: SHELL; Choices: bash, elvish, fish, powershell, zsh |
| `--install` | Install the script into your shell instead of printing it | Default: false |
| `--no-rc` | With --install: don't edit your shell rc; print the lines to add | Default: false |
| `--output` | Output format \[default: human, or `rig config set output …`] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table |
| `--query` | Filter output with a JMESPath expression | Global; Value: JMESPATH |
| `--cli-input-json` | Read inputs from a JSON file or '-' (stdin) | Global; Value: FILE |
| `--cli-input-yaml` | Read inputs from a YAML file or '-' (stdin) | Global; Value: FILE; Conflicts: cli\_input\_json |
| `--generate-cli-skeleton` | Print a fillable input template, then exit | Global; Default: false |
| `--no-pager` | Do not pipe help output through a pager | Global; Default: false |
| `-v, --verbose` | Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy` | Global; Default: false |
| `-h, --help` | Print help | |

> **Complete command help**
>
> ```text theme={null}
> Generate or install a shell completion script
>
> Usage: rigbox completions [OPTIONS] [SHELL]
>
> Arguments:
>   [SHELL]
>           Shell to target (auto-detected from the invoking shell when omitted)
>
>           [possible values: bash, elvish, fish, powershell, zsh]
>
> Options:
>       --install
>           Install the script into your shell instead of printing it
>
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>       --no-rc
>           With --install: don't edit your shell rc; print the lines to add
>
>       --query <JMESPATH>
>           Filter output with a JMESPath expression
>
>       --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 completions [OPTIONS] [SHELL]
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `shell` | Shell to target (auto-detected from the invoking shell when omitted) | Value: SHELL; Choices: bash, elvish, fish, powershell, zsh |
| `--install` | Install the script into your shell instead of printing it | Default: false |
| `--no-rc` | With --install: don't edit your shell rc; print the lines to add | Default: false |
| `--output` | Output format \[default: human, or `rig config set output …`] | Global; Value: OUTPUT; Choices: human, json, yaml, text, table |
| `--query` | Filter output with a JMESPath expression | Global; Value: JMESPATH |
| `--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}
> Generate or install a shell completion script
>
> Usage: rigbox completions [OPTIONS] [SHELL]
>
> Arguments:
>   [SHELL]
>           Shell to target (auto-detected from the invoking shell when omitted)
>
>           [possible values: bash, elvish, fish, powershell, zsh]
>
> Options:
>       --install
>           Install the script into your shell instead of printing it
>
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>       --no-rc
>           With --install: don't edit your shell rc; print the lines to add
>
>       --query <JMESPATH>
>           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
> ```


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