buildah CLI reference

ModularPipelines.Buildah provides strongly typed access to the buildah CLI.

Executable prerequisite

This package does not install the buildah executable. Install it separately and ensure buildah is available on PATH.

Follow the executable's official documentation for installation instructions.

Package installation

dotnet add package ModularPipelines.Buildah

Resolve the service with context.Tools.Buildah. Projects using C# 13 or another .NET language can use context.Tools.Get<ModularPipelines.Buildah.Services.IBuildah>() instead.

Module example

using ModularPipelines;
using ModularPipelines.Buildah.Enums;
using ModularPipelines.Buildah.Options;

public class RunCommandModule : Module<CommandResult>
{
    protected override async Task<CommandResult> ExecuteAsync(
        IModuleContext context,
        CancellationToken cancellationToken)
    {
        return await context.Tools.Buildah.ContainersAsync(
            new BuildahContainersOptions(),
            cancellationToken: cancellationToken);
    }
}

Global options

Global options are rendered after the selected subcommand.

CLI option	Property	Availability	Description
--cgroup-manager	CgroupManager	All editions	cgroup manager (default "cgroupfs")
--log-level	LogLevel	All editions	the log level to be used, one of "trace", "debug", "info", "warn", "error", "fatal", or "panic" (default "warn")
--registries-conf	RegistriesConf	All editions	path to registries.conf file (not usually used)
--registries-conf-dir	RegistriesConfDir	All editions	path to registries.conf.d directory (not usually used)
--root	Root	All editions	storage root dir (default "~/.local/share/containers/storage")
--runroot	Runroot	All editions	storage state dir (default "/run/user/1001/containers")
--short-name-alias-conf	ShortNameAliasConf	All editions	path to short name alias cache file (not usually used)
--storage-driver	StorageDriver	All editions	storage-driver (default "overlay")
--storage-opt	StorageOpt	All editions	storage driver option
--userns-gid-map	UsernsGidMap	All editions	default ctrID:hostID:length GID mapping to use
--userns-uid-map	UsernsUidMap	All editions	default ctrID:hostID:length UID mapping to use

Commands

CLI command	Options record
buildah add	BuildahAddOptions
buildah build	BuildahBuildOptions
buildah commit	BuildahCommitOptions
buildah config	BuildahConfigOptions
buildah containers	BuildahContainersOptions
buildah copy	BuildahCopyOptions
buildah from	BuildahFromOptions
buildah images	BuildahImagesOptions
buildah inspect	BuildahInspectOptions
buildah login	BuildahLoginOptions
buildah logout	BuildahLogoutOptions
buildah manifest	BuildahManifestOptions
buildah manifest add	BuildahManifestAddOptions
buildah manifest annotate	BuildahManifestAnnotateOptions
buildah manifest create	BuildahManifestCreateOptions
buildah manifest exists	BuildahManifestExistsOptions
buildah manifest inspect	BuildahManifestInspectOptions
buildah manifest push	BuildahManifestPushOptions
buildah manifest remove	BuildahManifestRemoveOptions
buildah manifest rm	BuildahManifestRmOptions
buildah mkcw	BuildahMkcwOptions
buildah mount	BuildahMountOptions
buildah prune	BuildahPruneOptions
buildah pull	BuildahPullOptions
buildah push	BuildahPushOptions
buildah rename	BuildahRenameOptions
buildah rm	BuildahRmOptions
buildah rmi	BuildahRmiOptions
buildah run	BuildahRunOptions
buildah source	BuildahSourceOptions
buildah source add	BuildahSourceAddOptions
buildah source create	BuildahSourceCreateOptions
buildah source pull	BuildahSourcePullOptions
buildah source push	BuildahSourcePushOptions
buildah tag	BuildahTagOptions
buildah umount	BuildahUmountOptions
buildah unshare	BuildahUnshareOptions
buildah version	BuildahVersionOptions