Enum RigCommand 

pub enum RigCommand {
    Up {
        timeout: u64,
        with_module: Vec<String>,
        refresh: bool,
        accept_upstream_change: bool,
    },
    Down,
    Reset {
        timeout: u64,
        with_module: Vec<String>,
        refresh: bool,
        accept_upstream_change: bool,
    },
    Status,
    Logs {
        tail: u32,
        follow: bool,
        service: Option<String>,
    },
    Trial(TrialArgs),
    Module(ModuleArgs),
    Snapshot {
        output: Option<PathBuf>,
    },
    Restore {
        file: PathBuf,
        timeout: u64,
    },
}

Variants

Up

Bring the rig up (compose up -d –wait) and wait for the gateway: RUNNING, or uncommissioned-as-data (exit 0 + wizard hint in warnings)

Fields

timeout: u64

Wait budget in seconds — BOTH compose’s –wait-timeout and the commissioned probe deadline (default 300)

with_module: Vec<String>

Provision a third-party module for THIS invocation only (repeatable): ID@VERSION, e.g. git@2.3.4. ADDITIVE to any [rigs.NAME.modules.*] declared in config — a flag naming an id config already declares OVERRIDES that id’s version for this run; there is NO subtractive form (a config-declared module cannot be omitted via this flag — remove it from config instead)

refresh: bool

Re-verify every already-cached module version against its release feed before trusting it: an unchanged digest reuses the cache, a changed one REFUSES (exit 6) naming both digests — never silently accepted. Mutually exclusive with –accept-upstream-change (never implied by it)

accept_upstream_change: bool

Accept a changed digest the feed now reports for an already-cached module version — the deliberate, explicit way to accept a re-released artifact (downloads and verifies the NEW bytes, cached alongside the old entry, never over it). Mutually exclusive with –refresh

Down

Stop the rig (compose down –remove-orphans; volumes KEPT — reset owns the teardown half)

Reset

Tear the rig down AND remove its volumes (down -v –remove-orphans), then bring it back up fresh — destructive, refused without –yes; no stale project/trial state survives

Fields

timeout: u64

Wait budget in seconds — BOTH compose’s –wait-timeout and the commissioned probe deadline (default 300)

with_module: Vec<String>

Provision a third-party module for THIS invocation only (repeatable): ID@VERSION, e.g. git@2.3.4. Same additive/flag-wins/no-subtractive-form contract as rig up --with-module (reset runs the same up-half internally)

refresh: bool

Re-verify every already-cached module version against its release feed before trusting it (see rig up --refresh). Mutually exclusive with –accept-upstream-change

accept_upstream_change: bool

Accept a changed digest the feed now reports for an already-cached module version (see rig up --accept-upstream-change). Mutually exclusive with –refresh

Status

Structured status: services, ports, volumes (allowlist JSON; a down rig is exit-0 data)

Logs

Stream the rig’s container logs (compose logs passthrough — raw lines, no envelope in any mode; the third streaming exception, README-documented)

Fields

tail: u32

Lines to show from the end of each service’s logs

follow: bool

Follow: stream new lines as they occur (Ctrl-C stops — default process kill, no envelope)

service: Option<String>

One service’s logs only (see ign rig status for names)

Trial(TrialArgs)

Trial-license state: status is credential-free truth; reset (guarded) restarts an EXPIRED trial via the mechanism ladder (token-auth POST, else native gateway login)

Module(ModuleArgs)

Third-party module lifecycle beyond declaration: uninstall removes a module from the gateway entirely — guarded, and NOT undone by re-declaring it (Phase 19)

Snapshot

Snapshot the rig’s gateway: native gwbk (roaming backup, streamed) + per-project exports + manifest.json, composed in a timestamped directory — repeatable state

Fields

output: Option<PathBuf>

Output directory (default: ./ign-rig-snapshots/-/)

Restore

Restore a gwbk onto the rig’s gateway — destructive, refused without –yes; synchronous restore + restart, then a witnessed RUNNING wait

Fields

file: PathBuf

The gwbk file to restore (from ign rig snapshot)

timeout: u64

Post-restore RUNNING wait budget in seconds (floored at 300 — the gateway restarts after a restore)

Trait Implementations

impl Debug for RigCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for RigCommand

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 RigCommand

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