API

obs-img-utils

The command line interface provides obs image utilities.

This includes downloading images, checking packages in images and getting package version information.

obs-img-utils [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

--license

Show license information.

download

Download image from OBS repository specified by download-url.

obs-img-utils download [OPTIONS]

Options

--add-conditions

Invoke conditions process to specify conditions for image

--conditions-wait-time <conditions_wait_time>

Time (in seconds) to wait for conditions to be met. Retry period is 150 seconds and default is 0 seconds for no wait.

--extension <extension>

Image file extension. Examples: [tar.gz, raw.xz]

--checksum-extension <checksum_extension>

Image checksum file extension. Example: sha256

--disallow-licenses

Invoke license REPL to specify any licenses that should not be in the image.

--disallow-packages

Invoke packages REPL to specify any packages which should not be in the image. This can use a wildcard (*) to match a naming pattern like “*-mini”.

--skip-checksum-validation

Skip the image checksum validation.

-C, --config <config>

OBS Image utils config file to use. Default: ~/.config/obs_img_utils/config.yaml

--no-color

Remove ANSI color and styling from output.

--debug, --verbose

Display debug level logging to console.

--quiet

Disable console output.

--download-url <download_url>

URL for OBS download repository.

--target-dir <target_dir>

Directory to store downloaded images and checksums.

--image-name <image_name>

Required Image name to download from the download-url.

--arch <arch>

Architecture of the image.

Options

x86_64 | aarch64

--profile <profile>

The multibuild profile name for the image.

packages

Package commands.

obs-img-utils packages [OPTIONS] COMMAND [ARGS]...

list

Return a list of packages for the given image name.

obs-img-utils packages list [OPTIONS]

Options

--filter-licenses

Invoke license REPL to specify license filters

--filter-packages

Invoke packages REPL to specify package name filters

--output <output>

The output format (text|json)

Options

text | json

--no-headers

Do not print headers in text output

-C, --config <config>

OBS Image utils config file to use. Default: ~/.config/obs_img_utils/config.yaml

--no-color

Remove ANSI color and styling from output.

--debug, --verbose

Display debug level logging to console.

--quiet

Disable console output.

--download-url <download_url>

URL for OBS download repository.

--target-dir <target_dir>

Directory to store downloaded images and checksums.

--image-name <image_name>

Required Image name to download from the download-url.

--arch <arch>

Architecture of the image.

Options

x86_64 | aarch64

--profile <profile>

The multibuild profile name for the image.

show

Return information for the provided package name in the given image.

obs-img-utils packages show [OPTIONS]

Options

--package-name <package_name>

Required Name of the package.

--output <output>

The output format (text|json)

Options

text | json

--no-headers

Do not print headers in text output

-C, --config <config>

OBS Image utils config file to use. Default: ~/.config/obs_img_utils/config.yaml

--no-color

Remove ANSI color and styling from output.

--debug, --verbose

Display debug level logging to console.

--quiet

Disable console output.

--download-url <download_url>

URL for OBS download repository.

--target-dir <target_dir>

Directory to store downloaded images and checksums.

--image-name <image_name>

Required Image name to download from the download-url.

--arch <arch>

Architecture of the image.

Options

x86_64 | aarch64

--profile <profile>

The multibuild profile name for the image.