> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bead.run/llms.txt
> Use this file to discover all available pages before exploring further.

# bead snapshot CLI commands

> Look up bead snapshot CLI commands and flags for templates, saved machine state, forks, and fleets.

Run bead snapshot CLI commands for saved machine state and published templates for new machines. Check each asynchronous result before using its output.

## Templates

| Command | Purpose |
| - | - |
| `bead templates [--limit 20] [--cursor TOKEN]` | List published templates. |
| `bead templates --tools` | Read tool version inventory; this does not prove template publication. |
| `bead template-get ID` | Read template details. |
| `bead template-reserve --name NAME` | Reserve a template. |
| `bead template-build ID BUILD --input build.json` | Submit a custom build body. |
| `bead template-status ID BUILD [--offset 0] [--limit 100]` | Read build status and bounded logs. |
| `bead template-delete ID` | Delete a template. |

See [custom templates](https://docs.bead.run/templates/custom.md) for supported build inputs.

## Snapshots

```bash theme={null}
bead sandbox snapshot create "$MACHINE_ID" --name prepared
bead sandbox snapshot list
bead sandbox snapshot get "$SNAPSHOT_ID"
bead sandbox snapshot retention "$SNAPSHOT_ID" --retention-seconds 86400
bead sandbox snapshot retention "$SNAPSHOT_ID"
bead sandbox snapshot delete "$SNAPSHOT_ID"
```

Creation accepts `--inherit-credentials` and optional `--retention-seconds`. Credential inheritance is an explicit choice. Omit retention seconds on the retention command to clear expiry. `retire` is also available as a deletion command. Snapshots remain billed independently of the source machine. See [retention](https://docs.bead.run/snapshots/retention.md).

## Forks

```bash theme={null}
bead sandbox fork "$MACHINE_ID" --count 2 --timeout 300
bead sandbox fork-get "$FORK_ID"
```

The CLI accepts 1–20 children (default 1). Inspect the operation and every member outcome. Memory forks retain the source shape; see [fork a running machine](https://docs.bead.run/snapshots/fork.md).

## Fleets

```bash theme={null}
bead fleet --template base --size small --count 2 --timeout 300
```

Options are `--count`, `--template` (default `agents`), `--size` (default `medium`), `--timeout`, `--kind` and `--idle-timeout`. The API supports counts 1–10000; batches above 256 return asynchronous results to poll. Keep successful member IDs even if other members fail, and clean them up explicitly. See [parallel work](https://docs.bead.run/use-cases/parallel-work.md).


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