Enum Commands 

pub enum Commands {
    Pack {
        disk: Option<PathBuf>,
        memory: Option<PathBuf>,
        output: PathBuf,
        compression: String,
        encrypt: bool,
        train_dict: bool,
        block_size: u32,
        cdc: bool,
        min_chunk: u32,
        avg_chunk: u32,
        max_chunk: u32,
        silent: bool,
    },
    Info {
        snap: PathBuf,
        json: bool,
    },
    Diff {
        overlay: PathBuf,
        blocks: bool,
        files: bool,
    },
    Build {
        source: PathBuf,
        memory: Option<PathBuf>,
        output: PathBuf,
        profile: Option<String>,
        encrypt: bool,
        cdc: bool,
    },
    Analyze {
        input: PathBuf,
    },
    Convert {
        format: String,
        input: PathBuf,
        output: PathBuf,
        compression: String,
        block_size: u32,
        profile: Option<String>,
        silent: bool,
    },
    Boot {
        snap: String,
        ram: Option<String>,
        no_kvm: bool,
        network: String,
        backend: String,
        persist: Option<PathBuf>,
        qmp_socket: Option<PathBuf>,
        no_graphics: bool,
        vnc: bool,
    },
    Install {
        iso: PathBuf,
        primary_size: String,
        ram: String,
        output: PathBuf,
        no_graphics: bool,
        vnc: bool,
        cdc: bool,
    },
    Snap {
        socket: PathBuf,
        base: PathBuf,
        overlay: PathBuf,
        output: PathBuf,
    },
    Commit {
        base: PathBuf,
        overlay: PathBuf,
        output: PathBuf,
        compression: String,
        block_size: u32,
        keep_overlay: bool,
        flatten: bool,
        message: Option<String>,
        thin: bool,
    },
    Mount {
        snap: String,
        mountpoint: PathBuf,
        overlay: Option<PathBuf>,
        daemon: bool,
        rw: bool,
        cache_size: Option<String>,
        uid: u32,
        gid: u32,
        nbd: bool,
    },
    Unmount {
        mountpoint: PathBuf,
    },
    Doctor,
    Bench {
        image: PathBuf,
        block_size: Option<u32>,
        duration: Option<u64>,
        threads: Option<usize>,
    },
    Serve {
        snap: String,
        port: u16,
        daemon: bool,
        nbd: bool,
        s3: bool,
    },
    Keygen {
        output_dir: Option<PathBuf>,
    },
    Sign {
        key: PathBuf,
        image: PathBuf,
    },
    Verify {
        key: PathBuf,
        image: PathBuf,
    },
}

Top-level command categories

Variants

Pack

Pack data into a Hexz archive

Fields

disk: Option<PathBuf>

Path to disk image to pack

memory: Option<PathBuf>

Path to memory dump to pack

output: PathBuf

Output archive path (.hxz)

compression: String

Compression algorithm (lz4, zstd, none)

encrypt: bool

Enable encryption

train_dict: bool

Train compression dictionary

block_size: u32

Block size in bytes (must be > 0)

cdc: bool

Enable content-defined chunking (CDC)

min_chunk: u32

Minimum chunk size for CDC

avg_chunk: u32

Average chunk size for CDC

max_chunk: u32

Maximum chunk size for CDC

silent: bool

Suppress all output and progress bars

Info

Inspect archive metadata

Fields

snap: PathBuf

Path to archive

json: bool

Output as JSON

Diff

Show differences in overlay

Fields

overlay: PathBuf

Path to overlay

blocks: bool

Show block-level differences

files: bool

Show file-level differences

Build

Build archive from source directory

Fields

source: PathBuf

Source directory

memory: Option<PathBuf>

Optional memory dump

output: PathBuf

Output archive path

profile: Option<String>

Build profile

encrypt: bool

Enable encryption

cdc: bool

Enable CDC

Analyze

Analyze archive structure

Fields

input: PathBuf

Archive to analyze

Convert

Convert external formats to Hexz snapshot

Fields

format: String

Source format (tar, hdf5, webdataset)

input: PathBuf

Input file path

output: PathBuf

Output snapshot path (.hxz)

compression: String

Compression algorithm (lz4, zstd)

block_size: u32

Block size in bytes

profile: Option<String>

Build profile (ml, eda, embedded, generic, archival)

silent: bool

Suppress output

Boot

Boot a virtual machine from snapshot

Fields

snap: String

Snapshot to boot from

ram: Option<String>

RAM size (e.g., “4G”)

no_kvm: bool

Disable KVM acceleration

network: String

Network mode (user, bridge, none)

backend: String

Hypervisor backend (qemu, firecracker)

persist: Option<PathBuf>

Persistent overlay path

qmp_socket: Option<PathBuf>

QMP socket path for control

no_graphics: bool

Disable graphics (headless mode)

vnc: bool

Enable VNC server

Install

Install OS from ISO to snapshot

Fields

iso: PathBuf

Path to ISO image

primary_size: String

Virtual disk size (e.g., “10G”)

ram: String

RAM size (e.g., “4G”)

output: PathBuf

Output snapshot path

no_graphics: bool

Disable graphics

vnc: bool

Enable VNC

cdc: bool

Enable CDC

Snap

Create snapshot via QMP

Fields

socket: PathBuf

QMP socket path

base: PathBuf

Base snapshot

overlay: PathBuf

Overlay path

output: PathBuf

Output snapshot

Commit

Commit overlay changes to new snapshot

Fields

base: PathBuf

Base snapshot

overlay: PathBuf

Overlay with changes

output: PathBuf

Output snapshot

compression: String

Compression algorithm

block_size: u32

Block size (must be > 0)

keep_overlay: bool

Keep overlay file after commit

flatten: bool

Flatten all layers into single archive

message: Option<String>

Commit message

thin: bool

Create thin snapshot (reference base)

Mount

Mount snapshot as filesystem

Fields

snap: String

Snapshot to mount

mountpoint: PathBuf

Mount point directory

overlay: Option<PathBuf>

Overlay for writes

daemon: bool

Run as daemon

rw: bool

Enable read-write mode

cache_size: Option<String>

Cache size (e.g., “1G”)

uid: u32

User ID for files

gid: u32

Group ID for files

nbd: bool

Export as NBD device

Unmount

Unmount filesystem

Fields

mountpoint: PathBuf

Mount point to unmount

Doctor

Run system diagnostics

Bench

Benchmark archive performance

Fields

image: PathBuf

Archive to benchmark

block_size: Option<u32>

Block size for testing

duration: Option<u64>

Duration in seconds

threads: Option<usize>

Number of threads

Serve

Serve archive over network

Fields

snap: String

Snapshot to serve

port: u16

Server port

daemon: bool

Run as daemon

nbd: bool

Enable NBD protocol

s3: bool

Enable S3-compatible API

Keygen

Generate signing keys

Fields

output_dir: Option<PathBuf>

Output directory for keys

Sign

Sign archive

Fields

key: PathBuf

Private key path

image: PathBuf

Archive to sign

Verify

Verify archive signature

Fields

key: PathBuf

Public key path

image: PathBuf

Archive to verify

Trait Implementations

impl FromArgMatches for Commands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Commands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand