Skip to content

Commit 99bd2c5

Browse files
mishushakovclaude
andcommitted
docs(sandbox): use snapshot terminology on Forking page
The docs consistently call the operation snapshotting; "checkpoint" only appears as an informal noun. Align the Forking page (and its Snapshots cross-link) with that vocabulary. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent ed42e05 commit 99bd2c5

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/sandbox/fork.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
22
title: "Sandbox forking"
33
sidebarTitle: Forking
4-
description: Checkpoint a running sandbox and boot new sandboxes from that exact state in a single call.
4+
description: Snapshot a running sandbox and boot new sandboxes from that exact state in a single call.
55
---
66

77
Forking lets you create running copies of a sandbox in a single call.
8-
The sandbox is checkpointed in place — briefly paused, snapshotted with its full filesystem and memory state, and resumed — and new sandboxes boot from that checkpoint.
8+
The sandbox is snapshotted in place — briefly paused, captured with its full filesystem and memory state, and resumed — and new sandboxes boot from that snapshot.
99

1010
Each fork is an independent sandbox with its own ID and timeout. It starts with the exact state the original had at the moment of the fork — files, running processes, loaded variables, and data — and diverges from there. The original sandbox keeps running with its ID and expiration untouched.
1111

1212
## Fork flow
1313

1414
```mermaid actions={false}
1515
graph LR
16-
A[Running Sandbox] -->|fork| B[Checkpointing]
16+
A[Running Sandbox] -->|fork| B[Snapshotting]
1717
B --> A
1818
B -->|count = N| C[Fork 1]
1919
B --> D[Fork 2]
2020
B --> E[Fork N]
2121
```
2222

23-
The snapshot is captured once regardless of how many forks you request, so forking into many sandboxes costs the same single checkpoint on the original.
23+
The snapshot is captured once regardless of how many forks you request, so forking into many sandboxes costs the same single snapshot of the original.
2424

2525
<Warning>
2626
During the fork, the original sandbox is temporarily paused and resumed. This causes all active connections (e.g. WebSocket, PTY, command streams) to be dropped. Make sure your client handles reconnection properly.
@@ -77,7 +77,7 @@ forks = Sandbox.fork(sandbox_id)
7777

7878
## Create multiple forks
7979

80-
Use `count` to boot several sandboxes from the same checkpoint in one call. You can request up to 100 forks at once.
80+
Use `count` to boot several sandboxes from the same snapshot in one call. You can request up to 100 forks at once.
8181

8282
<CodeGroup>
8383
```js JavaScript & TypeScript highlight={5}
@@ -162,7 +162,7 @@ Forking is a one-call shortcut for the common snapshot pattern: capture a runnin
162162
| | Forking | Snapshots |
163163
|---|---|---|
164164
| Result | Running sandboxes, ready to use | A persistent snapshot ID |
165-
| Reuse | Checkpoint is used once, for this call's forks | Snapshot can spawn sandboxes any time later |
165+
| Reuse | Snapshot is used once, for this call's forks | Snapshot can spawn sandboxes any time later |
166166
| Steps | One call | `createSnapshot()` / `create_snapshot()`, then `Sandbox.create()` per sandbox |
167167

168168
Use forking when you want running copies right now. Use [snapshots](/docs/sandbox/snapshots) when you want a durable checkpoint to create sandboxes from later.

docs/sandbox/snapshots.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,6 @@ Use snapshots when you need to capture or fork live runtime state that depends o
189189

190190
- **Checkpointing agent work** — an AI agent has loaded data and produced partial results in memory. Snapshot it so you can resume or fork from that point later.
191191
- **Rollback points** — snapshot before a risky or expensive operation (running untrusted code, applying a migration, refactoring a web app). If it fails, rollback - spawn a fresh sandbox from the snapshot before the operation happened.
192-
- **Forking workflows** — spawn multiple sandboxes from the same snapshot to explore different approaches in parallel. To checkpoint and spawn copies in a single call, see [Forking](/docs/sandbox/fork).
192+
- **Forking workflows** — spawn multiple sandboxes from the same snapshot to explore different approaches in parallel. To snapshot and spawn copies in a single call, see [Forking](/docs/sandbox/fork).
193193
- **Cached sandboxes** — avoid repeating expensive setup by snapshotting a sandbox that has already loaded a large dataset or started a long-running process.
194194
- **Sharing state** — one user or agent configures an environment interactively, snapshots it, and others start from that exact state.

0 commit comments

Comments
 (0)