commands.sh

apptainer

linux

Manage containers for HPC and scientific computing. Some subcommands such as `build`, `pull`, and `push` have their own usage documentation.

More info →

Subcommands (17)

apptainer build

Build Apptainer container images.

→
apptainer cache

Manage the local Apptainer cache.

→
apptainer capability

Manage Linux capabilities for users and groups.

→
apptainer config

Manage various Apptainer configurations.

→
apptainer delete

Delete container images from a remote library.

→
apptainer exec

Execute a command within an Apptainer container. See also: `apptainer run`, `apptainer shell`.

→
apptainer inspect

Display metadata of Apptainer container images.

→
apptainer overlay

Manage EXT3 writable overlay images for Apptainer containers.

→
apptainer pull

Pull container images from remote sources. See also: `apptainer-push`.

→
apptainer push

Push container images to remote registries. See also: `apptainer-pull`.

→
apptainer registry

Manage authentication to OCI/Docker registries. See also: `apptainer pull`, `apptainer push`.

→
apptainer run

Run the default runscript of an Apptainer container. The runscript is defined in the `%runscript` section of the container's definition file. See also: `apptainer exec`, `apptainer shell`.

→
apptainer search

Search a Container Library for container images.

→
apptainer shell

Start an interactive shell within an Apptainer container. See also: `apptainer exec`, `apptainer run`.

→
apptainer sign

Add digital signatures to a SIF container image. See also: `apptainer-verify`.

→
apptainer test

Run the testscript defined in an Apptainer container image. The testscript is defined in the `%test` section of the container's definition file.

→
apptainer verify

Verify digital signatures of SIF container images. See also: `apptainer-sign`.

→

Options (1)

-h, --helpboolean

Display help

Example: apptainer {{[-h|--help]}}

Examples (8)

Download a container from Docker Hub

apptainer pull path/to/image.sif docker://image:tag

Download a container from the Container Library

apptainer pull path/to/image.sif library://user/collection/container:tag

Build a container from a definition file

apptainer build path/to/image.sif path/to/definition.def

Start an interactive shell inside a container

apptainer shell path/to/image.sif

Execute a command inside a container

apptainer exec path/to/image.sif command

Run the default runscript of a container

apptainer run path/to/image.sif

Inspect a container's metadata

apptainer inspect path/to/image.sif

Display help

apptainer [-h|--help]
made by @shridhargupta | data from tldr-pages