> ## 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 snapshot rm

> Delete a snapshot

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

Use this command from your local terminal. Workspace-mode syntax, when available, is listed separately below.

## Examples

> [!WARNING]
>
> This command deletes a resource. Confirm the identifier and preserve any data you need before running the example.

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

```bash theme={null}
rig snapshot rm --workspace WORKSPACE_ID --snapshot SNAPSHOT
```

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

```bash theme={null}
rig snapshot rm --help
```

Aliases: [remove](https://docs.rigbox.dev/cli-reference/commands/snapshot/rm).

## Local syntax

```text theme={null}
Usage: rigbox snapshot rm [OPTIONS] --workspace <WORKSPACE> --snapshot <SNAPSHOT>
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `-w, --workspace` | Workspace name or id | Required; Value: WORKSPACE |
| `-s, --snapshot` | Snapshot id (from `rig snapshot ls`) | Required; Value: SNAPSHOT |
| `--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}
> Delete a snapshot
>
> Usage: rigbox snapshot rm [OPTIONS] --workspace <WORKSPACE> --snapshot <SNAPSHOT>
>
> Options:
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>   -w, --workspace <WORKSPACE>
>           Workspace name or id
>
>       --query <JMESPATH>
>           Filter output with a JMESPath expression
>
>   -s, --snapshot <SNAPSHOT>
>           Snapshot id (from `rig snapshot ls`)
>
>       --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 snapshot rm [OPTIONS] --workspace <WORKSPACE> --snapshot <SNAPSHOT>
```

### Arguments and flags

| Argument | Description | Details |
| - | - | - |
| `-w, --workspace` | Workspace name or id | Required; Value: WORKSPACE |
| `-s, --snapshot` | Snapshot id (from `rig snapshot ls`) | Required; Value: SNAPSHOT |
| `--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}
> Delete a snapshot
>
> Usage: rigbox snapshot rm [OPTIONS] --workspace <WORKSPACE> --snapshot <SNAPSHOT>
>
> Options:
>       --output <OUTPUT>
>           Output format [default: human, or `rig config set output …`]
>
>           [possible values: human, json, yaml, text, table]
>
>   -w, --workspace <WORKSPACE>
>           Workspace name or id
>
>       --query <JMESPATH>
>           Filter output with a JMESPath expression
>
>   -s, --snapshot <SNAPSHOT>
>           Snapshot id (from `rig snapshot ls`)
>
>       --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.