Enum Command 

pub enum Command {
    InternalStdinWatchdog {
        parent_pid: u32,
    },
    Build {
        name: Option<String>,
        rebuild: bool,
        no_diff: bool,
        edit: bool,
    },
    Enable {
        name: Option<String>,
    },
    Disable {
        name: Option<String>,
        force: bool,
    },
    Start {
        name: Option<String>,
        timeout: u64,
        edit: bool,
    },
    Stop {
        name: Option<String>,
    },
    Exec {
        root: bool,
        args: Vec<String>,
    },
    Run {
        app: String,
        app_args: Vec<String>,
    },
    Status {
        name: Option<String>,
        output: OutputFormat,
    },
    Logs {
        name: Option<String>,
        follow: bool,
        tail: Option<u32>,
        since: Option<String>,
    },
    Export {
        export_cmd: ExportCommand,
    },
    Stats {
        name: Option<String>,
        no_stream: bool,
        output: OutputFormat,
    },
    Remove {
        name: Option<String>,
        all: bool,
        force: bool,
        stale: bool,
        config: bool,
    },
    Inspect {
        name: Option<String>,
        config: bool,
        quadlet: bool,
        env: bool,
        output: OutputFormat,
    },
    Serve {
        name: String,
    },
    Compositor {
        name: String,
    },
    Enter {
        name: Option<String>,
        edit: bool,
    },
    Create {
        image: String,
        name: Option<String>,
        packages: Option<String>,
        no_start: bool,
        edit: bool,
    },
    Edit {
        name: Option<String>,
        rebuild: bool,
    },
    List {
        output: OutputFormat,
    },
    Clone {
        src: String,
        dst: String,
        copy_home: bool,
    },
    Init {
        image: Option<String>,
        name: Option<String>,
        interactive: bool,
        profile: Option<String>,
    },
    Update {
        name: Option<String>,
        no_restart: bool,
    },
    Pull {
        image: Option<String>,
    },
    Profile {
        profile_cmd: ProfileCommand,
    },
    Doctor {
        name: Option<String>,
        fix: bool,
        output: OutputFormat,
    },
    Completions {
        shell: Shell,
        abbrs: bool,
    },
    Diff {
        name: Option<String>,
        apply: bool,
        output: OutputFormat,
    },
    Snapshot {
        snapshot_cmd: SnapshotCommand,
    },
    Restore {
        tag: String,
        name: Option<String>,
    },
    Use {
        name: Option<String>,
        clear: bool,
    },
    FindDefinition {
        name: Option<String>,
    },
    Recover {
        name: Option<String>,
        yes: bool,
    },
    History {
        name: Option<String>,
        limit: usize,
        output: OutputFormat,
    },
    TranslatePath {
        to_container: bool,
        to_host: bool,
        path: String,
    },
    Migrate {
        force: bool,
    },
    CompleteNames,
}

Variants

InternalStdinWatchdog

Internal stdin watchdog for interactive sessions. Not for direct use.

Fields

parent_pid: u32

PID of the process to terminate when stdin hangs up.

Build

Build the container image from the definition.

Fields

name: Option<String>

Container name to build (overrides auto-detection).

rebuild: bool

Force rebuild even if definition hasn’t changed.

no_diff: bool

Skip post-build drift check.

edit: bool

Open config in editor before building.

Enable

Install Quadlet systemd files and enable the container.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

Disable

Disable and remove Quadlet systemd files.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

force: bool

Skip config loading and remove Quadlet files by name only.

Start

Start the container.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

timeout: u64

Maximum seconds to wait for the container to become ready.

edit: bool

Open config in editor before starting.

Stop

Stop the container.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

Exec

Execute a command interactively in the container.

Fields

root: bool

Run as root inside the container (omit -u flag).

args: Vec<String>

Command and arguments to execute.

Run

Run a GUI application in the container (detached).

Fields

app: String

Application to run.

app_args: Vec<String>

Additional arguments for the application.

Status

Show container status.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

output: OutputFormat

Output format (text or json).

Logs

Show container logs.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

follow: bool

Follow log output.

tail: Option<u32>

Number of lines to show from the end (default: 50).

since: Option<String>

Show logs since this duration (e.g. “5m”, “1h”, “2024-01-01”).

Export

Export a .desktop app or binary shim to the host.

Fields

export_cmd: ExportCommand

Stats

Show resource usage for the container (wraps podman stats).

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

no_stream: bool

Only show one snapshot, don’t stream.

output: OutputFormat

Output format (text or json).

Remove

Remove the container.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

all: bool

Also remove the home directory.

force: bool

Skip confirmation prompt.

stale: bool

Remove stale/orphaned containers (no valid config, not running).

config: bool

Also delete the TOML definition file.

Inspect

Inspect container configuration, generated Quadlet, or computed environment.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

config: bool

Show the resolved TOML config.

quadlet: bool

Show the generated Quadlet (.container file).

env: bool

Show the computed environment variables.

output: OutputFormat

Output format (text or json).

Serve

Run the host socket server (socket-activated by systemd).

Fields

name: String

Container name to serve.

Compositor

Run the Wayland firewall proxy (systemd companion service).

Fields

name: String

Container name to proxy.

Enter

Open an interactive shell in the container.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

edit: bool

Open config in editor before entering shell.

Create

Create and start a container from a profile or image in one step.

Fields

image: String

Profile name (fedora, cachy) or full image reference.

name: Option<String>

Override the container name.

packages: Option<String>

Comma-separated list of packages to install (e.g. “fastfetch,btop”).

no_start: bool

Skip starting the container after setup.

edit: bool

Open config in editor before creating.

Edit

Open the container config in your preferred editor.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

rebuild: bool

After saving, rebuild the image if image config changed.

List

List all managed containers.

Fields

output: OutputFormat

Output format (text or json).

Clone

Clone an existing container config to a new name.

Fields

src: String

Source container name.

dst: String

Destination container name.

copy_home: bool

Also copy the home directory contents.

Init

Initialize a new container config.

Fields

image: Option<String>

Base image reference (e.g. “fedora:44”) for a non-prebuilt container. If omitted, defaults to “fedora:44”.

name: Option<String>

Container name (defaults to the image name).

interactive: bool

Run an interactive wizard to build the config.

profile: Option<String>

Use a named profile (cachy, fedora, dev) as template.

Update

Pull the latest image and restart the container.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

no_restart: bool

Skip restart after update.

Pull

Pull a prebuilt image without building.

Fields

image: Option<String>

Distro shorthand or full image reference.

Profile

Manage container profiles.

Fields

profile_cmd: ProfileCommand

Doctor

Run diagnostic checks.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

fix: bool

Auto-fix common issues (e.g. corrupted Wayland socket ownership).

output: OutputFormat

Output format (text or json).

Completions

Generate shell completions.

Fields

shell: Shell

Shell to generate completions for.

abbrs: bool

Also print daily-driver abbr shorthand (fish only).

Diff

Compare declared packages against the running container.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

apply: bool

Update the config TOML’s install list to match the container.

output: OutputFormat

Output format (text or json).

Snapshot

Snapshot the current container state as a tagged image.

Fields

snapshot_cmd: SnapshotCommand

Restore

Restore a container from a snapshot.

Fields

tag: String

Tag of the snapshot to restore.

name: Option<String>

Container name (overrides auto-detection / active context).

Use

Set or show active context.

Fields

name: Option<String>

Container name to set as active (omit to show current context).

clear: bool

Clear the active context.

FindDefinition

Find the definition file that would be used.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

Recover

Guided repair for a container that won’t start.

Fields

name: Option<String>

Container name (overrides auto-detection / active context).

yes: bool

Run every step without prompting.

History

Show the recent lifecycle action history.

Fields

name: Option<String>

Container name filter (leave empty for all containers).

limit: usize

Maximum number of entries to show (0 = no limit).

output: OutputFormat

Output format (text or json).

TranslatePath

Translate a path between host and container.

Fields

to_container: bool

Direction of translation.

to_host: bool

Direction of translation.

path: String

Path to translate.

Migrate

Migrate legacy config files from ~/.config/podbox/ to ~/.config/podbox/profiles/

Fields

force: bool

Overwrite files in target profiles/ directory if they exist.

CompleteNames

Print known container names, one per line (shell completion helper).

Trait Implementations

impl FromArgMatches for Command

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 Command

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