apptainer

Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC)

Synopsis

Apptainer containers provide an application virtualization layer enabling mobility of compute via both application and environment portability. With Apptainer one is capable of building a root file system that runs on any other Linux system where Apptainer is installed.

apptainer [global options...]

Examples

$ apptainer help <command> [<subcommand>]
$ apptainer help build
$ apptainer help instance start

Options

    --build-config    use configuration needed for building containers
-c, --config string   specify a configuration file (for root or unprivileged installation only) (default "/usr/local/etc/apptainer/apptainer.conf")
-d, --debug           print debugging information (highest verbosity)
-h, --help            help for apptainer
    --nocolor         print without color output (default False)
-q, --quiet           suppress normal output
-s, --silent          only print errors
-v, --verbose         print additional information

SEE ALSO

• apptainer build - Build an Apptainer image

• apptainer cache - Manage the local cache

• apptainer capability - Manage Linux capabilities for users and groups

• apptainer checkpoint - Manage container checkpoint state (experimental)

• apptainer config - Manage various apptainer configuration (root user only)

• apptainer delete - Deletes requested image from the library

• apptainer exec - Run a command within a container

• apptainer inspect - Show metadata for an image

• apptainer instance - Manage containers running as services

• apptainer key - Manage OpenPGP keys

• apptainer keyserver - Manage apptainer keyservers

• apptainer oci - Manage OCI containers

• apptainer overlay - Manage an EXT3 writable overlay image

• apptainer plugin - Manage Apptainer plugins

• apptainer pull - Pull an image from a URI

• apptainer push - Upload image to the provided URI

• apptainer registry - Manage authentication to OCI/Docker registries

• apptainer remote - Manage apptainer remote endpoints

• apptainer run - Run the user-defined default command within a container

• apptainer run-help - Show the user-defined help for an image

• apptainer search - Search a Container Library for images

• apptainer shell - Run a shell within a container

• apptainer sif - Manipulate Singularity Image Format (SIF) images

• apptainer sign - Add digital signature(s) to an image

• apptainer test - Run the user-defined tests within a container

• apptainer verify - Verify digital signature(s) within an image

• apptainer version - Show the version for Apptainer

Auto generated by spf13/cobra on 29-Oct-2025