community man page

apptainer

GNU

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

8 examples·source: tldr · CC-BY·status: verified

Reading is open to everyone. Suggesting a flag, fixing an example or adding a recipe is opening to verified-email accounts soon — every change is moderated before it goes live.

curl https://curlhub.sh/man/apptainer

same page, in your terminal

Examples

Download a container from Docker Hub GNU

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

Download a container from the Container Library GNU

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

Build a container from a definition file GNU

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

Start an interactive shell inside a container GNU

apptainer shell path/to/image.sif

Execute a command inside a container GNU

apptainer exec path/to/image.sif command

Run the default runscript of a container GNU

apptainer run path/to/image.sif

Inspect a container's metadata GNU

apptainer inspect path/to/image.sif

Display help GNU

apptainer [-h|--help]