<!-- enhance-docs page=reference/cli/recording/snapshot -->
<!-- enhance-docs release-sha256=8a804cfc9a6fc6b942b8daf6a82266ad6e308291ae4351abee3346bc696d1258 -->

# enhance-dev recording snapshot

```text
enhance-dev recording snapshot [options]
```

## Arguments

This command takes no positional arguments.

## Options

| Option | Required | Default | Meaning |
| --- | --- | --- | --- |
| `--canvas <url-or-id>` | Yes | None | Canvas URL or UUID containing the recording. |
| `--recording-id <uuid>` | Yes | None | Recording id, from `enhance recording list` or `recording start`. |
| `--at-ms <integer>` | Yes | None | Accepted recording timestamp in milliseconds. |
| `--timeout-ms <integer>` | No | `120000` | Local polling deadline in milliseconds. |
| `--client-token <uuid>` | No | None | Stable UUID to reuse when retrying the exact same mutation. |

## Input

This command presents the capability `recording.snapshot`. It has write effect and single idempotency.

<details class="reference-schema">
<summary>Show complete input JSON Schema</summary>

```json
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"recordingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"atMs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visually reviewed recording timestamp to persist, in milliseconds."},"timeoutMs":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Local snapshot polling deadline in milliseconds."}},"required":["canvasId","recordingId","atMs","timeoutMs"]}
```
</details>


## Output

This command writes JSON records to standard output. Returns a typed recording.snapshot result from the Enhance API without transport-specific prose.

<details class="reference-schema">
<summary>Show complete output JSON Schema</summary>

```json
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"screenId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"screenNodeId":{"type":"string","minLength":1},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"retryClientToken":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"next":{"type":"array","items":{"type":"string"}}},"required":["jobId","canvasId","screenId","screenNodeId","version","retryClientToken","next"],"additionalProperties":{}}
```
</details>


## Examples

```bash
enhance-dev recording snapshot --canvas <url-or-id> --recording-id <uuid> --at-ms <integer>
```

<details class="reference-schema">
<summary>Show example input</summary>

```json
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "recordingId": "00000000-0000-4000-8000-000000000010",
 "atMs": 1000,
 "timeoutMs": 120000
}
```
</details>

<details class="reference-schema">
<summary>Show example output</summary>

```json
{
 "jobId": "00000000-0000-4000-8000-000000000010",
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "screenId": "00000000-0000-4000-8000-000000000010",
 "screenNodeId": "screen_ready",
 "version": 2,
 "retryClientToken": "00000000-0000-4000-8000-000000000010",
 "next": [
  "Render the screen."
 ]
}
```
</details>

## Exit behaviour

| Exit code | Meaning |
| --- | --- |
| `0` | The command succeeded. |
| `1` | The command failed for another reason (`INTERNAL`). A write may have an unknown outcome. |
| `2` | The command line was malformed. Nothing ran. |
| `3` | The API refused the input (`BAD_REQUEST`). |
| `4` | The credential is missing or expired (`UNAUTHORIZED`). |
| `5` | The API refused the request (`FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `RATE_LIMITED`). |
| `6` | A batch finished only in part. Retry with the same `--client-token`. |

## Versions

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.
