Let's document: Apptainer

[emmanuel-ferdman]

Command description

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

Documentation

https://apptainer.org/docs/user/latest/quick_start.html

Platform

Linux

VCS repository link (e.g. GitHub, GitLab)

https://github.com/apptainer/apptainer

Additional information

No response

Commands

Main

• apptainer - apptainer*: add page #20443

Image Lifecycle Commands

• apptainer build - apptainer*: add page #20443
• apptainer pull - apptainer*: add page #20443
• apptainer push - apptainer*: add page #20443
• apptainer delete - apptainer-delete: add page #20522
• apptainer inspect - apptainer-inspect: add page #20559
• apptainer search
• apptainer sign
• apptainer verify

SIF (Singularity Image Format) Commands

• apptainer sif
• apptainer sif add
• apptainer sif del
• apptainer sif dump
• apptainer sif header
• apptainer sif info
• apptainer sif list
• apptainer sif new
• apptainer sif setprim

Overlay Commands

• apptainer overlay
• apptainer overlay create

Runtime Commands

• apptainer run
• apptainer run-help
• apptainer exec
• apptainer shell
• apptainer test

Instance Commands

• apptainer instance
• apptainer instance list
• apptainer instance run
• apptainer instance start
• apptainer instance stats
• apptainer instance stop

OCI Commands

• apptainer oci
• apptainer oci attach
• apptainer oci create
• apptainer oci delete
• apptainer oci exec
• apptainer oci kill
• apptainer oci mount
• apptainer oci pause
• apptainer oci resume
• apptainer oci run
• apptainer oci start
• apptainer oci state
• apptainer oci umount
• apptainer oci update

Cache Commands

• apptainer cache
• apptainer cache clean
• apptainer cache list

Config Commands

• apptainer config
• apptainer config fakeroot
• apptainer config global

Remote Commands

• apptainer remote
• apptainer remote add
• apptainer remote get-login-password
• apptainer remote list
• apptainer remote login
• apptainer remote logout
• apptainer remote remove
• apptainer remote status
• apptainer remote use

Registry Commands

• apptainer registry
• apptainer registry list
• apptainer registry login
• apptainer registry logout

Plugin Commands

• apptainer plugin
• apptainer plugin compile
• apptainer plugin create
• apptainer plugin disable
• apptainer plugin enable
• apptainer plugin inspect
• apptainer plugin install
• apptainer plugin list
• apptainer plugin uninstall

Key Commands

• apptainer key
• apptainer key export
• apptainer key import
• apptainer key list
• apptainer key newpair
• apptainer key pull
• apptainer key push
• apptainer key remove
• apptainer key search

Keyserver Commands

• apptainer keyserver
• apptainer keyserver add
• apptainer keyserver list
• apptainer keyserver login
• apptainer keyserver logout
• apptainer keyserver remove

Capability Commands

• apptainer capability
• apptainer capability add
• apptainer capability avail
• apptainer capability drop
• apptainer capability list

Checkpoint Commands (Experimental)

• apptainer checkpoint
• apptainer checkpoint create
• apptainer checkpoint delete
• apptainer checkpoint instance
• apptainer checkpoint list

Other Commands

• apptainer version