Struct Cmdline

pub struct Cmdline {
    pub debug: bool,
    pub registry: Option<PathBuf>,
    pub workdir: PathBuf,
    pub outdir: PathBuf,
    pub mirror: String,
    pub user: String,
    pub password: String,
    pub cleanup: bool,
    pub cleanup_bootstrap: bool,
    pub action: Action,
}

Command line usage

This tool uses the subcommand approach to specify the action to take.

./target/release/mkrawimg [GLOBAL_OPTIONS] action [OPTIONS] [--] ARG [ARG..]

Global options

• --debug: Enables the debug output. Does not have a short option.
• -r, --registry: Overrides the path to the device registry.
• -D, --workdir: Overrides the working directory path. The default path is ./work.
• -O, --outdir: Overrides the output directory path. The default path is ./out.
• -m, --mirror: Overrides the package repository mirror for package downloads. The default mirror is the AOSC OS upstream mirror.
• -U, --user: Overrides the username of the built-in user. The default username is aosc.
• -P, --password: Overrides the password of the built-in user. The default password is anthon.
• -c, --cleanup: Clean up the sketch directories after building, to free some space.
• -C, --cleanup-bootstrap: Clean up the bootstrapped system distributions after building, to free some space.

Actions

• build: Build images for one specific device.
• build-all: Build images for all devices registered in the registry.
• check: Check the validity of the device specification files.
• list: List all of the devices registered in the registry.

Notes

• All actions has their specific options, please refer the action’s documentation for available options.
• Some actions may require addition arguments following the options.

Action build

This action builds images for one specific device.

./target/release/mkrawimg [GLOBAL_OPTIONS] build [OPTIONS] [--] DEVICE

Options for build

• -f, --fstype FSTYPE

  Override the filesystem type of the root filesystem.

  Possible values are: btrfs, ext4, xfs.

• -x, --compression COMPRESSION

  Specify the compression format of the output image.

  Possible values are: xz, zstd, gzip, none. The default is xz.

• -V, --variants VARIANT [VARIANT...]

  Select distribution variants to build, must specify at least one variant.

  Possible values are: base, desktop, server. If not specified, all variants will be built.

• -r, --revision REVISION

  Use a positive integer as the revision of the image. The revision will be added to the filename of the output.

• -p, --additional-packages PKG [PKG...]

  Supply a list of package names to install into the target system. This does not override the defined list.

• -T, --topics TOPIC [TOPIC..]

  Enroll addition topic(s) during installation.

Arguments for build

The build action takes exactly one argument: DEVICE.

DEVICE is a string identifying the target device. It can be one of the following:

• A device ID defined in the device specification file.
• A device alias defined in the device specification file.
• Path to the device specification file device.toml.
• Path to the directory containing the device.toml. The specification file must reside directly within this directory.

Usage examples for build

Suppose the registry at ./devices contains a device with ID rpi-5b and a few aliases: pi5, pi5b. This device represents the Raspberry Pi 5 Model B. The specification file is located at raspberrypi/rpi-5b/device.toml within the registry.

The following usages are all valid:

# Use device ID or alias
mkrawimg build rpi-5b
mkrawimg build pi5
mkrawimg build pi5b
# Use the path to the specification file
mkrawimg build ./devices/raspberrypi/rpi-5b/device.toml
# Supply the (relative) path to the directory containing the target device specification file
mkrawimg build raspberrypi/rpi-5b

By default images are built for all distribution variants. You can override this by using -V or --variants:

# Build for the base variant only
mkrawimg build -V base -- rpi-5b
# Build for the base and desktop variants
mkrawimg build -V base -V desktop -- rpi-5b
# Same way as above
mkrawimg build -V base desktop -- rpi-5b

You must use -- to delimit the variants from the device argument. Otherwise "rpi-5b" will be incorrectly parsed as a variant, leading to errors.

Action build-all

This action builds images for all devices within the registry.

# ./target/release/mkrawimg [GLOBAL_OPTIONS] build-all [OPTIONS]

The build-all action takes the same options as the build action. See above for available options.

The build-all action takes no arguments.

Action check

This action checks for the validity of the device specificatoin files.

./target/release/mkrawimg [GLOBAL_OPTIONS] check

check action does not take any options besides the global options, and it does not take any arguments.

Action list

This action lists the available devices within the registry.

./target/releases/mkrawimg [--registry REGISTRY] list [OPTIONS]

Other global options are accepted but almost all options except --registry are ignored.

list action takes no arguments.

Options for list

• -f, --format

  Specify the list format.

  Possible values are:

  • pretty: A table-like format which shows the basic information of devices.
  • simple: A much simpler format which contains three colums splitted by tab character ('\t'), and one device per line.

Fields

debug: bool

Turns on debug output.

registry: Option<PathBuf>

Override path to the device registry

workdir: PathBuf

Working directory

outdir: PathBuf

Output directory

mirror: String

The mirror to download packages from.

user: String

Specify username for the OS

password: String

Specify password for the OS

cleanup: bool

Clean up the sketch directory after building

cleanup_bootstrap: bool

Clean up the bootstrapped system distributions after building

action: Action

The action to take.

Trait Implementations

impl Args for Cmdline

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

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

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

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

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

impl CommandFactory for Cmdline

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 FromArgMatches for Cmdline

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cmdline

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::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][Error::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][Error::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.