Enum MicrosandboxSubcommand

pub enum MicrosandboxSubcommand {
    Init {
        file: Option<PathBuf>,
    },
    Add {

        sandbox: bool,
        build: bool,
        group: bool,
        names: Vec<String>,
        image: String,
        memory: Option<u32>,
        cpus: Option<u32>,
        volumes: Vec<String>,
        ports: Vec<String>,
        envs: Vec<String>,
        env_file: Option<Utf8UnixPathBuf>,
        depends_on: Vec<String>,
        workdir: Option<Utf8UnixPathBuf>,
        shell: Option<String>,
        scripts: Vec<(String, String)>,
        start: Option<String>,
        imports: Vec<(String, String)>,
        exports: Vec<(String, String)>,
        scope: Option<String>,
        file: Option<PathBuf>,
    
},
    Remove {
        sandbox: bool,
        build: bool,
        group: bool,
        names: Vec<String>,
        file: Option<PathBuf>,
    },
    List {
        sandbox: bool,
        build: bool,
        group: bool,
        file: Option<PathBuf>,
    },
    Log {
        sandbox: bool,
        build: bool,
        group: bool,
        name: String,
        file: Option<PathBuf>,
        follow: bool,
        tail: Option<usize>,
    },
    Tree {
        sandbox: bool,
        build: bool,
        group: bool,
        names: Vec<String>,
        level: Option<usize>,
    },
    Run {
        sandbox: bool,
        build: bool,
        name: String,
        file: Option<PathBuf>,
        detach: bool,
        exec: Option<String>,
        args: Vec<String>,
    },
    Shell {
        sandbox: bool,
        build: bool,
        name: String,
        file: Option<PathBuf>,
        detach: bool,
        args: Vec<String>,
    },
    Exe {
        image: bool,
        name: String,
        cpus: Option<u8>,
        memory: Option<u32>,
        volumes: Vec<String>,
        ports: Vec<String>,
        envs: Vec<String>,
        workdir: Option<Utf8UnixPathBuf>,
        scope: Option<String>,
        exec: Option<String>,
        args: Vec<String>,
    },
    Install {
        image: bool,
        name: String,
        alias: Option<String>,
        cpus: Option<u8>,
        memory: Option<u32>,
        volumes: Vec<String>,
        ports: Vec<String>,
        envs: Vec<String>,
        workdir: Option<Utf8UnixPathBuf>,
        scope: Option<String>,
        exec: Option<String>,
        args: Vec<String>,
    },
    Uninstall {
        script: Option<String>,
    },
    Apply {
        file: Option<PathBuf>,
        detach: bool,
    },
    Up {
        sandbox: bool,
        build: bool,
        group: bool,
        names: Vec<String>,
        file: Option<PathBuf>,
        detach: bool,
    },
    Down {
        sandbox: bool,
        build: bool,
        group: bool,
        names: Vec<String>,
        file: Option<PathBuf>,
    },
    Status {
        sandbox: bool,
        build: bool,
        group: bool,
        names: Vec<String>,
        file: Option<PathBuf>,
    },
    Clean {
        sandbox: bool,
        name: Option<String>,
        user: bool,
        all: bool,
        file: Option<PathBuf>,
        force: bool,
    },
    Build {
        build: bool,
        sandbox: bool,
        group: bool,
        names: Vec<String>,
        snapshot: bool,
    },
    Pull {
        image: bool,
        image_group: bool,
        name: Reference,
        layer_path: Option<PathBuf>,
    },
    Login,
    Push {
        image: bool,
        image_group: bool,
        name: String,
    },
    Self_ {
        action: SelfAction,
    },
    Server {
        subcommand: ServerSubcommand,
    },
    Version,
}

Available subcommands for managing services

Variants

Init

Initialize a new microsandbox project

Fields

file: Option<PathBuf>

Path to the sandbox file or the project directory

Add

Add a new sandbox to the project

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

group: bool

Whether command should apply to a group

names: Vec<String>

Names of components to add

image: String

Image to use

memory: Option<u32>

Memory in MiB

cpus: Option<u32>

Number of CPUs

volumes: Vec<String>

Volume mappings, format: <host_path>:<container_path>

ports: Vec<String>

Port mappings, format: <host_port>:<container_port>

envs: Vec<String>

Environment variables, format: =

env_file: Option<Utf8UnixPathBuf>

Environment file

depends_on: Vec<String>

Dependencies

workdir: Option<Utf8UnixPathBuf>

Working directory

shell: Option<String>

Shell to use

scripts: Vec<(String, String)>

Scripts to add

start: Option<String>

Start script

imports: Vec<(String, String)>

Files to import, format: =

exports: Vec<(String, String)>

Files to export, format: =

scope: Option<String>

Network scope, options: local, public, any, none

file: Option<PathBuf>

Path to the sandbox file or the project directory

Remove

Remove a sandbox from the project

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

group: bool

Whether command should apply to a group

names: Vec<String>

Names of components to remove

file: Option<PathBuf>

Path to the sandbox file or the project directory

List

List sandboxes defined in the project

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

group: bool

Whether command should apply to a group

file: Option<PathBuf>

Path to the sandbox file or the project directory

Log

Show logs of a build, sandbox, or group

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

group: bool

Whether command should apply to a group

name: String

Name of the component

file: Option<PathBuf>

Path to the sandbox file or the project directory

follow: bool

Follow the logs

tail: Option<usize>

Number of lines to show from the end

Tree

Show tree of layers that make up a sandbox

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

group: bool

Whether command should apply to a group

names: Vec<String>

Names of components to show

level: Option<usize>

Maximum depth level

Run

Run a sandbox defined in the project

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

name: String

Name of the component

file: Option<PathBuf>

Path to the sandbox file or the project directory

detach: bool

Run sandbox in the background

exec: Option<String>

Execute a command within the sandbox

args: Vec<String>

Additional arguments after --. Passed to the script or exec.

Shell

Open a shell in a sandbox

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

name: String

Name of the component

file: Option<PathBuf>

Path to the sandbox file or the project directory

detach: bool

Run sandbox in the background

args: Vec<String>

Additional arguments after --. Passed to the shell.

Exe

Run a temporary sandbox

Fields

image: bool

Whether command should apply to a sandbox

name: String

Name of the image

cpus: Option<u8>

Number of CPUs

memory: Option<u32>

Memory in MB

volumes: Vec<String>

Volume mappings, format: <host_path>:<container_path>

ports: Vec<String>

Port mappings, format: <host_port>:<container_port>

envs: Vec<String>

Environment variables, format: =

workdir: Option<Utf8UnixPathBuf>

Working directory

scope: Option<String>

Network scope, options: local, public, any, none

exec: Option<String>

Execute a command within the sandbox

args: Vec<String>

Additional arguments after --. Passed to the script or exec.

Install

Install a script from an image

Fields

image: bool

Whether command should apply to a sandbox

name: String

Name of the image

alias: Option<String>

Alias for the script

cpus: Option<u8>

Number of CPUs

memory: Option<u32>

Memory in MB

volumes: Vec<String>

Volume mappings, format: <host_path>:<container_path>

ports: Vec<String>

Port mappings, format: <host_port>:<container_port>

envs: Vec<String>

Environment variables, format: =

workdir: Option<Utf8UnixPathBuf>

Working directory

scope: Option<String>

Network scope, options: local, public, any, none

exec: Option<String>

Execute a command within the sandbox

args: Vec<String>

Additional arguments after --. Passed to the script or exec.

Uninstall

Uninstall a script

Fields

script: Option<String>

Script to uninstall

Apply

Start or stop project sandboxes based on configuration

Fields

file: Option<PathBuf>

Path to the sandbox file or the project directory

detach: bool

Run sandboxes in the background

Up

Run a project’s sandboxes

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

group: bool

Whether command should apply to a group

names: Vec<String>

Names of components to start. If omitted, starts all sandboxes defined in the configuration.

file: Option<PathBuf>

Path to the sandbox file or the project directory

detach: bool

Run sandboxes in the background

Down

Stop a project’s sandboxes

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

group: bool

Whether command should apply to a group

names: Vec<String>

Names of components to stop. If omitted, stops all sandboxes defined in the configuration.

file: Option<PathBuf>

Path to the sandbox file or the project directory

Status

Show statuses of a project’s running sandboxes

Fields

sandbox: bool

Whether command should apply to a sandbox

build: bool

Whether command should apply to a build sandbox

group: bool

Whether command should apply to a group

names: Vec<String>

Names of components to show status for

file: Option<PathBuf>

Path to the sandbox file or the project directory

Clean

Clean cached sandbox layers, metadata, etc.

Fields

sandbox: bool

Whether command should apply to a sandbox

name: Option<String>

Name of the component

user: bool

Clean user-level caches. This cleans $MICROSANDBOX_HOME

all: bool

Clean all

file: Option<PathBuf>

Path to the sandbox file or the project directory

force: bool

Force clean

Build

Build images

Fields

build: bool

Build from build definition

sandbox: bool

Build from sandbox

group: bool

Build from group

names: Vec<String>

Names of components to build

snapshot: bool

Create a snapshot

Pull

Pull image from a registry

Fields

image: bool

Whether command should apply to an image

image_group: bool

Whether command should apply to an image group

name: Reference

Name of the image or image group

layer_path: Option<PathBuf>

Path to store the layer files

Login

Login to a registry

Push

Push image to a registry

Fields

image: bool

Whether command should apply to an image

image_group: bool

Whether command should apply to an image group

name: String

Name of the image or image group

Self_

Manage microsandbox itself

Fields

action: SelfAction

Action to perform

Server

Start a sandbox server for orchestrating and working with sandboxes

Fields

subcommand: ServerSubcommand

The subcommand to run

Version

Print version of microsandbox

Trait Implementations

impl CommandFactory for MicrosandboxSubcommand

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for MicrosandboxSubcommand

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

Formats the value using the given formatter.

impl FromArgMatches for MicrosandboxSubcommand

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 Parser for MicrosandboxSubcommand

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for MicrosandboxSubcommand

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