Data, snapshots, and bases

Commands for persistent storage and filesystem state. For the concepts, see Data volumes and Snapshots and bases.

data

Manage persistent data volumes, snapshots, and backups

zomg data <command>

Subcommand	Description
`list`	List data volumes
`create`	Create a new data volume
`delete`	Delete a data volume
`attach`	Attach a data volume to a box at a mount path
`detach`	Detach a data volume from a box
`snapshot`	Manage data volume snapshots
`backup`	Manage remote backups for a data volume
`restore`	Restore a data volume from a backup or query restore status

# Create a data volume and attach to a box
zomg data create my-data
zomg data attach my-data my-box --path /data

# Clone from an existing data volume snapshot
zomg data create copy --from my-data --from-snapshot backup1

# Detach (data is preserved)
zomg data detach my-data my-box

# Snapshot a data volume
zomg data snapshot create my-data backup1 -m "Before migration"
zomg data snapshot restore my-data backup1

# Remote backups
zomg data backup create my-data -m "nightly"
zomg data backup wait my-data bkp-20260101010101-ab12cd
zomg data restore my-data bkp-20260101010101-ab12cd
zomg data restore status my-data restore-20260101010101-ab12cd

list

List data volumes

zomg data list [options]

Argument / option	Description
`-a, --all`	Include all projects.
`-q, --quiet`	Print names only.
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

create

Create a new data volume

zomg data create <NAME> [options]

Argument / option	Description
`<NAME>`	Name for the new data volume
`--from <FROM_DATA>`	Source data volume to clone from (requires —from-snapshot)
`--from-snapshot <FROM_SNAPSHOT>`	Source snapshot name (requires —from)
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

delete

Delete a data volume

zomg data delete <NAME> [options]

Argument / option	Description
`<NAME>`	Name.
`-p, --project <PROJECT>`	Target project.

attach

Attach a data volume to a box at a mount path

zomg data attach <DATA> <BOX_NAME> [options]

Argument / option	Description
`<DATA>`	Data volume name
`<BOX_NAME>`	Box to attach to
`--path <PATH>`	Mount path inside the box (must be absolute and outside reserved roots)
`--read-only`	Mount as read-only
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

detach

Detach a data volume from a box

zomg data detach <DATA> <BOX_NAME> [options]

Argument / option	Description
`<DATA>`	Data volume name
`<BOX_NAME>`	Box to detach from
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

snapshot

Manage data volume snapshots

zomg data snapshot <command>

Subcommand	Description
`list`	List snapshots of a data volume
`create`	Create a snapshot of a data volume
`restore`	Restore a data volume to a snapshot

list

List snapshots of a data volume

zomg data snapshot list <DATA> [options]

Argument / option	Description
`<DATA>`	Data volume name.
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

create

Create a snapshot of a data volume

zomg data snapshot create <DATA> [<NAME>] [options]

Argument / option	Description
`<DATA>`	Data volume to snapshot
`<NAME>`	Snapshot name (auto-generated if omitted)
`--name <NAME_FLAG>`	Snapshot name (flag form, overrides positional)
`-m, --message <MESSAGE>`	Description for this snapshot
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

restore

Restore a data volume to a snapshot

zomg data snapshot restore <DATA> <SNAPSHOT> [options]

Argument / option	Description
`<DATA>`	Data volume name.
`<SNAPSHOT>`	Snapshot name.
`-p, --project <PROJECT>`	Target project.

backup

Manage remote backups for a data volume

zomg data backup <command>

Subcommand	Description
`create`	Create a backup and upload it to configured remote storage
`list`	List backups for a data volume
`show`	Show one backup
`wait`	Wait for a backup to reach a terminal state

create

Create a backup and upload it to configured remote storage

zomg data backup create <DATA> [<NAME>] [options]

Argument / option	Description
`<DATA>`	Data volume to back up
`<NAME>`	Backup name (auto-generated if omitted)
`--name <NAME_FLAG>`	Backup name (flag form, overrides positional)
`-m, --message <MESSAGE>`	Description for this backup
`--no-wait`	Return without waiting for completion
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

list

List backups for a data volume

zomg data backup list <DATA> [options]

Argument / option	Description
`<DATA>`	Data volume name.
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

show

Show one backup

zomg data backup show <DATA> <BACKUP> [options]

Argument / option	Description
`<DATA>`	Data volume name.
`<BACKUP>`	Backup name.
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

wait

Wait for a backup to reach a terminal state

zomg data backup wait <DATA> <BACKUP> [options]

Argument / option	Description
`<DATA>`	Data volume name.
`<BACKUP>`	Backup name.
`--timeout <TIMEOUT>`	Defaults to `900`.
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

restore

Restore a data volume from a backup or query restore status

zomg data restore <FIRST> <SECOND> [<THIRD>] [options]

Argument / option	Description
`<FIRST>`	Use one of: restore <data> <backup> restore status <data> <operation-id> (requires 3 positional args)
`<SECOND>`	Backup name, or operation id when the first argument is `status`.
`<THIRD>`	Operation id, when checking restore status.
`--no-wait`	Return without waiting for completion (only for restore start)
`--timeout <TIMEOUT>`	Defaults to `900`.
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

snapshot

Capture and restore box root-filesystem checkpoints

zomg snapshot <command>

Subcommand	Description
`list`	List snapshots for a box
`create`	Create a snapshot of box’s root filesystem
`restore`	Restore box to a previous snapshot (destructive)

# Create a named snapshot
zomg snapshot create my-box v1 -m "Before upgrade"

# List snapshots
zomg snapshot list my-box

# Restore to a previous snapshot (destructive)
zomg snapshot restore my-box v1

list

List snapshots for a box

zomg snapshot list <BOX_NAME> [options]

Argument / option	Description
`<BOX_NAME>`	Box ref.
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

create

Create a snapshot of box’s root filesystem

zomg snapshot create <BOX_NAME> [<NAME>] [options]

Argument / option	Description
`<BOX_NAME>`	Box ref.
`<NAME>`	Snapshot name (auto-generated if omitted)
`--name <NAME_FLAG>`	Snapshot name (flag form, overrides positional)
`-m, --message <MESSAGE>`	Description for this snapshot
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

restore

Restore box to a previous snapshot (destructive)

zomg snapshot restore <BOX_NAME> <SNAPSHOT> [options]

Argument / option	Description
`<BOX_NAME>`	Box ref.
`<SNAPSHOT>`	Snapshot name.
`-p, --project <PROJECT>`	Target project.

base

Manage base image templates

zomg base <command>

Subcommand	Description
`list`	List available base images
`show`	Show base versions and provenance
`build`	Build a base from Dockerfile in current directory
`install`	Install a base into the selected environment on demand
`update`	Rebuild and install a base into the selected environment
`save`	Save a box’s filesystem as a new base
`import`	Import a tar.gz file as a base
`delete`	Delete a base alias or exact version

# List available bases
zomg base list

# Show base versions and scripts
zomg base show box-base

# Build base from Dockerfile in current directory
zomg base build my-base

# Save a box filesystem as a new base
zomg base save my-base my-box

# Import a tarball as a base
zomg base import my-base --file rootfs.tar.gz --parent box-base

# Delete a base alias and all versions it owns
zomg base delete alias my-base

# Delete one old immutable base version
zomg base delete version my-base-v20260101120000

list

List available base images

zomg base list [options]

Argument / option	Description
`-j, --json`	Print the JSON response.

show

Show base versions and provenance

zomg base show <NAME> [options]

Argument / option	Description
`<NAME>`	Name.
`--tag <TAG>`	Base version tag.
`-j, --json`	Print the JSON response.

build

Build a base from Dockerfile in current directory

zomg base build <NAME> [options]

Argument / option	Description
`<NAME>`	Name.
`--script-sha256 <SCRIPT_SHA256>`	Provenance hash recorded on the built base version
`--builder <BUILDER>`	Provenance builder recorded on the built base version
`-j, --json`	Print the JSON response.

install

Install a base into the selected environment on demand

zomg base install <NAME>

Argument / option	Description
`<NAME>`	Name.

update

Rebuild and install a base into the selected environment

zomg base update <NAME>

Argument / option	Description
`<NAME>`	Name.

save

Save a box’s filesystem as a new base

zomg base save <BASE> <BOX_NAME> [options]

Argument / option	Description
`<BASE>`	Base name.
`<BOX_NAME>`	Box ref.
`-p, --project <PROJECT>`	Target project.
`--script <SCRIPT>`	Provenance script recorded on the saved base version
`--script-sha256 <SCRIPT_SHA256>`	Provenance hash recorded on the saved base version
`--parent-alias <PARENT_ALIAS>`	Provenance parent alias recorded on the saved base version
`--parent-version <PARENT_VERSION>`	Provenance parent version recorded on the saved base version
`--builder <BUILDER>`	Provenance builder recorded on the saved base version
`-j, --json`	Print the JSON response.

import

Import a tar.gz file as a base

zomg base import <NAME> [options]

Argument / option	Description
`<NAME>`	Name for the new base
`--file <FILE>`	Path to tar.gz file containing root filesystem
`-p, --parent <PARENT>`	Parent base to layer on top of
`--script-sha256 <SCRIPT_SHA256>`	Provenance hash recorded on the imported base version
`--parent-alias <PARENT_ALIAS>`	Provenance parent alias recorded on the imported base version
`--parent-version <PARENT_VERSION>`	Provenance parent version recorded on the imported base version
`--builder <BUILDER>`	Provenance builder recorded on the imported base version
`-j, --json`	Print the JSON response.

delete

Delete a base alias or exact version

zomg base delete <command>

Subcommand	Description
`alias`	Delete a base alias and all versions it owns
`version`	Delete one immutable base version

alias

Delete a base alias and all versions it owns

zomg base delete alias <ALIAS>

Argument / option	Description
`<ALIAS>`	Base alias to delete with all versions it owns

version

Delete one immutable base version

zomg base delete version <VERSION>

Argument / option	Description
`<VERSION>`	Exact immutable base version to delete

diff

Show filesystem changes in a box since a snapshot

zomg diff <command>

Subcommand	Description
`status`	Show summary of changed files
`file`	Show diff for a specific file

# Show changed files since last snapshot
zomg diff status my-box

# Compare against specific snapshot
zomg diff status my-box --against v1

# Show diff for a specific file
zomg diff file my-box /etc/config.json --against v1

status

Show summary of changed files

zomg diff status <BOX_NAME> [options]

Argument / option	Description
`<BOX_NAME>`	Box ref.
`--against <AGAINST>`	Snapshot to compare against (default: most recent)
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

file

Show diff for a specific file

zomg diff file <BOX_NAME> <PATH> [options]

Argument / option	Description
`<BOX_NAME>`	Box ref.
`<PATH>`	Root filesystem path; /home, /box/bin, /box/all, and /box/proj are rejected
`--against <AGAINST>`	Snapshot to compare against (default: most recent)
`-p, --project <PROJECT>`	Target project.
`-j, --json`	Print the JSON response.

​data

​list

​create

​delete

​attach

​detach

​snapshot

​list

​create

​restore

​backup

​create

​list

​show

​wait

​restore

​snapshot

​list

​create

​restore

​base

​list

​show

​build

​install

​update

​save

​import

​delete

​alias

​version

​diff

​status

​file

data

list

create

delete

attach

detach

snapshot

list

create

restore

backup

create

list

show

wait

restore

snapshot

list

create

restore

base

list

show

build

install

update

save

import

delete

alias

version

diff

status

file