Skip to content
Fuse
Esc
navigateopen⌘Jpreview
On this page

fuse environment fork

Fork an environment into a new one

fuse environment fork <id> [flags]

Creates a new environment seeded from an existing one’s state.

Flags

Flag Purpose
--reuse-snapshot Reuse an existing snapshot ID instead of taking a new one.
--comment Comment recorded on the seed snapshot the fork creates.

Behavior

With no --reuse-snapshot, the server takes a fresh snapshot of <id> first, then forks from it. With --reuse-snapshot, it skips that step and forks directly from the named snapshot instead, which also makes --comment a no-op, there is no new snapshot for it to be recorded on.

fuse environment fork fuse-abc123 --comment "branch for experiment"
# forked environment "fuse-abc123" into fuse-xyz789
fuse environment fork fuse-abc123 --reuse-snapshot snap-1

Fork is unavailable wherever snapshotting is, GPU/QEMU-backed environments cannot be forked. See Snapshots and Providers.

Errors

Status Code When
404 not_found --reuse-snapshot names a snapshot that belongs to a different environment.
409 conflict The reused snapshot is not in the ready state, or the source environment holds a GPU passthrough device.
500 internal The source environment is not running.

The 404 reads confusingly when the snapshot plainly exists: a snapshot of another environment is rejected as not-found rather than as a mismatch.

Was this page helpful?