NAME

       singularity.apptainer - Singularity containers command line interface

DESCRIPTION

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

   Usage:
              apptainer [global options...]

   Description:
              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.

OPTIONS

       --build-config
              use configuration needed for building containers

       -c, --config string
              specify  a  configuration  file  (for   root   or   unprivileged   installation   only)   (default
              "/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

       --version
              version for apptainer

   Available Commands:
       build  Build an Apptainer image

       cache  Manage the local cache

       capability
              Manage Linux capabilities for users and groups

       checkpoint
              Manage container checkpoint state (experimental)

       completion
              Generate the autocompletion script for the specified shell

       config Manage various apptainer configuration (root user only)

       delete Deletes requested image from the library

       exec   Run a command within a container

       help   Help about any command

       inspect
              Show metadata for an image

       instance
              Manage containers running as services

       key    Manage OpenPGP keys

       keyserver
              Manage apptainer keyservers

       oci    Manage OCI containers

       overlay
              Manage an EXT3 writable overlay image

       plugin Manage Apptainer plugins

       pull   Pull an image from a URI

       push   Upload image to the provided URI

       registry
              Manage authentication to OCI/Docker registries

       remote Manage apptainer remote endpoints

       run    Run the user-defined default command within a container

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

       search Search a Container Library for images

       shell  Run a shell within a container

       sif    Manipulate Singularity Image Format (SIF) images

       sign   Add digital signature(s) to an image

       test   Run the user-defined tests within a container

       verify Verify digital signature(s) within an image

       version
              Show the version for Apptainer

EXAMPLES

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

       For additional help or support, please visit https://apptainer.org/help/

singularity.apptainer 1.4.0-6                       July 2025                           SINGULARITY.APPTAINER(1)