Enum Commands 

pub enum Commands {
    Pack {

        output: PathBuf,
        disk: Option<PathBuf>,
        memory: Option<PathBuf>,
        compression: String,
        encrypt: bool,
        train_dict: bool,
        block_size: u32,
        min_chunk: Option<u32>,
        avg_chunk: Option<u32>,
        max_chunk: Option<u32>,
        workers: Option<usize>,
        dcam: bool,
        silent: bool,
    
},
    Import {
        input: PathBuf,
        output: PathBuf,
        base: Option<PathBuf>,
        compression: String,
        block_size: u32,
        silent: bool,
    },
    Export {
        input: PathBuf,
        output: Option<PathBuf>,
        tensor: Option<String>,
    },
    Show {
        snap: PathBuf,
        json: bool,
    },
    Diff {
        a: PathBuf,
        b: PathBuf,
    },
    Log {
        dir: PathBuf,
    },
    Build {
        source: PathBuf,
        output: PathBuf,
        memory: Option<PathBuf>,
        profile: Option<String>,
        encrypt: bool,
    },
    Convert {
        format: String,
        input: PathBuf,
        output: PathBuf,
        compression: String,
        block_size: u32,
        profile: Option<String>,
        silent: bool,
    },
    Predict {
        file: PathBuf,
        block_size: u32,
        min_chunk: Option<u32>,
        avg_chunk: Option<u32>,
        max_chunk: Option<u32>,
        json: 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,
        output: PathBuf,
        primary_size: String,
        ram: String,
        no_graphics: bool,
        vnc: 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,
        memory: Option<PathBuf>,
        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,
        prefetch: Option<u32>,
    },
    Unmount {
        mountpoint: PathBuf,
    },
    Doctor,
    Serve {
        snap: String,
        port: u16,
        bind: String,
        daemon: bool,
        nbd: bool,
    },
    Keygen {
        output_dir: Option<PathBuf>,
    },
    Sign {
        key: PathBuf,
        image: PathBuf,
    },
    Verify {
        key: PathBuf,
        image: PathBuf,
    },
}

Top-level command categories

Variants

Pack

Pack files into a snapshot

Fields

output: PathBuf

Output archive path (.hxz)

disk: Option<PathBuf>

Path to disk image to pack

memory: Option<PathBuf>

Path to memory dump to pack

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)

min_chunk: Option<u32>

Minimum CDC chunk size (auto-detected if not specified)

avg_chunk: Option<u32>

Average CDC chunk size (auto-detected if not specified)

max_chunk: Option<u32>

Maximum CDC chunk size (auto-detected if not specified)

workers: Option<usize>

Number of compression worker threads (0 = auto)

dcam: bool

Run DCAM analysis to auto-tune CDC chunk sizes (slower but adaptive). Without this flag, CDC uses global defaults: min=16 KiB, avg=64 KiB, max=256 KiB.

silent: bool

Suppress all output and progress bars

Import

Import safetensors as a snapshot

Fields

input: PathBuf

Input .safetensors file

output: PathBuf

Output .hxz archive

base: Option<PathBuf>

Parent .hxz archive for delta deduplication

compression: String

Compression algorithm (lz4, zstd)

block_size: u32

Block size in bytes

silent: bool

Suppress progress output

Export

Export safetensors from a snapshot

Fields

input: PathBuf

Input .hxz archive

output: Option<PathBuf>

Output .safetensors file (default: .safetensors)

tensor: Option<String>

Extract a single tensor by name (raw bytes, no header)

Show

Show snapshot details

Fields

snap: PathBuf

Path to archive

json: bool

Output as JSON

Diff

Compare two snapshots

Fields

a: PathBuf

First archive

b: PathBuf

Second archive

Log

Show snapshot lineage tree

Fields

dir: PathBuf

Directory to scan

Build

Pack with profile presets

Fields

source: PathBuf

Source disk image

output: PathBuf

Output archive path

memory: Option<PathBuf>

Optional memory dump

profile: Option<String>

Build profile

encrypt: bool

Enable encryption

Convert

Convert external formats to 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)

silent: bool

Suppress output

Predict

Estimate compression savings

Fields

file: PathBuf

Path to the raw data file to analyze

block_size: u32

Block size in bytes

min_chunk: Option<u32>

Minimum CDC chunk size (auto-detected if not specified)

avg_chunk: Option<u32>

Average CDC chunk size (auto-detected if not specified)

max_chunk: Option<u32>

Maximum CDC chunk size (auto-detected if not specified)

json: bool

Output as JSON

Boot

Boot a VM 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

output: PathBuf

Output snapshot path

primary_size: String

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

ram: String

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

no_graphics: bool

Disable graphics

vnc: bool

Enable VNC

Snap

Take a live VM snapshot

Fields

socket: PathBuf

QMP socket path

base: PathBuf

Base snapshot

overlay: PathBuf

Overlay path

output: PathBuf

Output snapshot

Commit

Commit overlay 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

memory: Option<PathBuf>

Path to memory dump to include

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

prefetch: Option<u32>

Prefetch window size (number of blocks to read ahead)

Unmount

Unmount snapshot filesystem

Fields

mountpoint: PathBuf

Mount point to unmount

Doctor

Check system requirements

Serve

Serve snapshot over network

Fields

snap: String

Snapshot to serve

port: u16

Server port

bind: String

Bind address

daemon: bool

Run as daemon

nbd: bool

Enable NBD protocol

Keygen

Generate signing keypair

Fields

output_dir: Option<PathBuf>

Output directory for keys

Sign

Sign a snapshot

Fields

key: PathBuf

Private key path

image: PathBuf

Archive to sign

Verify

Verify snapshot 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