Package apptainer

Application and environment virtualization

Apptainer provides functionality to make portable
containers that can be used across host environments.

Version: 1.1.3

General Commands

apptainer Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC)
apptainer-build Build an Apptainer image
apptainer-cache Manage the local cache
apptainer-cache-clean Clean your local Apptainer cache
apptainer-cache-list List your local Apptainer cache
apptainer-capability Manage Linux capabilities for users and groups
apptainer-capability-add Add capabilities to a user or group (requires root)
apptainer-capability-avail Show description for available capabilities
apptainer-capability-drop Remove capabilities from a user or group (requires root)
apptainer-capability-list Show capabilities for a given user or group
apptainer-checkpoint Manage container checkpoint state (experimental)
apptainer-checkpoint-create Create empty checkpoint storage (experimental)
apptainer-checkpoint-delete Delete a checkpoint (experimental)
apptainer-checkpoint-instance Checkpoint the state of a running instance (experimental)
apptainer-checkpoint-list List local checkpoints (experimental)
apptainer-config Manage various apptainer configuration (root user only)
apptainer-config-fakeroot Manage fakeroot user mappings entries (root user only)
apptainer-config-global Edit apptainer.conf from command line (root user only or unprivileged installation)
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-instance-list List all running and named Apptainer instances
apptainer-instance-start Start a named instance of the given container image
apptainer-instance-stats Get stats for a named instance
apptainer-instance-stop Stop a named instance of a given container image
apptainer-key Manage OpenPGP keys
apptainer-key-export Export a public or private key into a specific file
apptainer-key-import Import a local key into the local or global keyring
apptainer-key-list List keys in your local or in the global keyring
apptainer-key-newpair Create a new key pair
apptainer-key-pull Download a public key from a key server
apptainer-key-push Upload a public key to a key server
apptainer-key-remove Remove a local public key from your local or the global keyring
apptainer-key-search Search for keys on a key server
apptainer-oci Manage OCI containers
apptainer-oci-attach Attach console to a running container process (root user only)
apptainer-oci-create Create a container from a bundle directory (root user only)
apptainer-oci-delete Delete container (root user only)
apptainer-oci-exec Execute a command within container (root user only)
apptainer-oci-kill Kill a container (root user only)
apptainer-oci-mount Mount create an OCI bundle from SIF image (root user only)
apptainer-oci-pause Suspends all processes inside the container (root user only)
apptainer-oci-resume Resumes all processes previously paused inside the container (root user only)
apptainer-oci-run Create/start/attach/delete a container from a bundle directory (root user only)
apptainer-oci-start Start container process (root user only)
apptainer-oci-state Query state of a container (root user only)
apptainer-oci-umount Umount delete bundle (root user only)
apptainer-oci-update Update container cgroups resources (root user only)
apptainer-overlay Manage an EXT3 writable overlay image
apptainer-overlay-create Create EXT3 writable overlay image
apptainer-plugin Manage Apptainer plugins
apptainer-plugin-compile Compile an Apptainer plugin
apptainer-plugin-create Create a plugin skeleton directory
apptainer-plugin-disable disable an installed Apptainer plugin
apptainer-plugin-enable Enable an installed Apptainer plugin
apptainer-plugin-inspect Inspect an Apptainer plugin (either an installed one or an image)
apptainer-plugin-install Install a compiled Apptainer plugin
apptainer-plugin-list List installed Apptainer plugins
apptainer-plugin-uninstall Uninstall removes the named plugin from the system
apptainer-pull Pull an image from a URI
apptainer-push Upload image to the provided URI
apptainer-remote Manage apptainer remote endpoints, keyservers and OCI/Docker registry credentials
apptainer-remote-add Add a new apptainer remote endpoint
apptainer-remote-add-keyserver Add a keyserver (root user only)
apptainer-remote-list List all apptainer remote endpoints, keyservers, and OCI credentials that are configured
apptainer-remote-login Login to an Apptainer remote endpoint, an OCI/Docker registry or a keyserver using credentials
apptainer-remote-logout Log out from an Apptainer remote endpoint, an OCI/Docker registry or a keyserver
apptainer-remote-remove Remove an existing apptainer remote endpoint
apptainer-remote-remove-keyserver Remove a keyserver (root user only)
apptainer-remote-status Check the status of the apptainer services at an endpoint, and your authentication token
apptainer-remote-use Set an Apptainer remote endpoint to be actively used
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-sif-add Add data object
apptainer-sif-del Delete data object
apptainer-sif-dump Dump data object
apptainer-sif-header Display global header
apptainer-sif-info Display data object info
apptainer-sif-list List data objects
apptainer-sif-new Create SIF image
apptainer-sif-setprim Set primary system partition
apptainer-sign Attach digital signature(s) to an image
apptainer-test Run the user-defined tests within a container
apptainer-verify Verify cryptographic signatures attached to an image
apptainer-version Show the version for Apptainer
singularity alias for apptainer
singularity-build alias for apptainer-build
singularity-cache alias for apptainer-cache
singularity-cache-clean alias for apptainer-cache-clean
singularity-cache-list alias for apptainer-cache-list
singularity-capability alias for apptainer-capability
singularity-capability-add alias for apptainer-capability-add
singularity-capability-avail alias for apptainer-capability-avail
singularity-capability-drop alias for apptainer-capability-drop
singularity-capability-list alias for apptainer-capability-list
singularity-checkpoint alias for apptainer-checkpoint
singularity-checkpoint-create alias for apptainer-checkpoint-create
singularity-checkpoint-delete alias for apptainer-checkpoint-delete
singularity-checkpoint-instance alias for apptainer-checkpoint-instance
singularity-checkpoint-list alias for apptainer-checkpoint-list
singularity-config alias for apptainer-config
singularity-config-fakeroot alias for apptainer-config-fakeroot
singularity-config-global alias for apptainer-config-global
singularity-delete alias for apptainer-delete
singularity-exec alias for apptainer-exec
singularity-inspect alias for apptainer-inspect
singularity-instance alias for apptainer-instance
singularity-instance-list alias for apptainer-instance-list
singularity-instance-start alias for apptainer-instance-start
singularity-instance-stats alias for apptainer-instance-stats
singularity-instance-stop alias for apptainer-instance-stop
singularity-key alias for apptainer-key
singularity-key-export alias for apptainer-key-export
singularity-key-import alias for apptainer-key-import
singularity-key-list alias for apptainer-key-list
singularity-key-newpair alias for apptainer-key-newpair
singularity-key-pull alias for apptainer-key-pull
singularity-key-push alias for apptainer-key-push
singularity-key-remove alias for apptainer-key-remove
singularity-key-search alias for apptainer-key-search
singularity-oci alias for apptainer-oci
singularity-oci-attach alias for apptainer-oci-attach
singularity-oci-create alias for apptainer-oci-create
singularity-oci-delete alias for apptainer-oci-delete
singularity-oci-exec alias for apptainer-oci-exec
singularity-oci-kill alias for apptainer-oci-kill
singularity-oci-mount alias for apptainer-oci-mount
singularity-oci-pause alias for apptainer-oci-pause
singularity-oci-resume alias for apptainer-oci-resume
singularity-oci-run alias for apptainer-oci-run
singularity-oci-start alias for apptainer-oci-start
singularity-oci-state alias for apptainer-oci-state
singularity-oci-umount alias for apptainer-oci-umount
singularity-oci-update alias for apptainer-oci-update
singularity-overlay alias for apptainer-overlay
singularity-overlay-create alias for apptainer-overlay-create
singularity-plugin alias for apptainer-plugin
singularity-plugin-compile alias for apptainer-plugin-compile
singularity-plugin-create alias for apptainer-plugin-create
singularity-plugin-disable alias for apptainer-plugin-disable
singularity-plugin-enable alias for apptainer-plugin-enable
singularity-plugin-inspect alias for apptainer-plugin-inspect
singularity-plugin-install alias for apptainer-plugin-install
singularity-plugin-list alias for apptainer-plugin-list
singularity-plugin-uninstall alias for apptainer-plugin-uninstall
singularity-pull alias for apptainer-pull
singularity-push alias for apptainer-push
singularity-remote alias for apptainer-remote
singularity-remote-add alias for apptainer-remote-add
singularity-remote-add-keyserver alias for apptainer-remote-add-keyserver
singularity-remote-list alias for apptainer-remote-list
singularity-remote-login alias for apptainer-remote-login
singularity-remote-logout alias for apptainer-remote-logout
singularity-remote-remove alias for apptainer-remote-remove
singularity-remote-remove-keyserver alias for apptainer-remote-remove-keyserver
singularity-remote-status alias for apptainer-remote-status
singularity-remote-use alias for apptainer-remote-use
singularity-run alias for apptainer-run
singularity-run-help alias for apptainer-run-help
singularity-search alias for apptainer-search
singularity-shell alias for apptainer-shell
singularity-sif alias for apptainer-sif
singularity-sif-add alias for apptainer-sif-add
singularity-sif-del alias for apptainer-sif-del
singularity-sif-dump alias for apptainer-sif-dump
singularity-sif-header alias for apptainer-sif-header
singularity-sif-info alias for apptainer-sif-info
singularity-sif-list alias for apptainer-sif-list
singularity-sif-new alias for apptainer-sif-new
singularity-sif-setprim alias for apptainer-sif-setprim
singularity-sign alias for apptainer-sign
singularity-test alias for apptainer-test
singularity-verify alias for apptainer-verify
singularity-version alias for apptainer-version