SINGULARITY.APPTAINER(1)

📦
version 1.4.5 · 3 versions
, in ubuntu stonking

✨ SINGULARITY.APPTAINER(1) ✨

okay bestie, we're in the <pink>singularity.apptainer</pink> manual page, section <purple>1</purple> (that's "user commands" energy 💅), and honestly? it's giving main character. buckle up 🎀

🌸 NAME 🌸

singularity.apptainer — the Singularity containers command line interface. yep. that's the whole name. short, sweet, iconic 👑

💖 DESCRIPTION 💖

it's a Linux container platform, and it's optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC). no cap. 🦋

🫶 Usage:

apptainer [global options...]

🧚 Description:

so here's the vibe: Apptainer containers give you an application virtualization layer that enables mobility of compute via both application and environment portability. literally what that means is — with Apptainer you can build a root file system that runs on any other Linux system where Apptainer is installed. any of them. slay. 🔥

✨ OPTIONS ✨

  • --build-config — use the configuration that's needed for building containers 🏗️
  • -c, --config string — specify a configuration file (only for root or unprivileged installation, iykyk) (default "/etc/apptainer/apptainer.conf") 📝
  • -d, --debug — print debugging information, and this one is the highest verbosity. like, the loudest one. the most debug. 💀
  • -h, --help — help for apptainer 🫶
  • --nocolor — print without color output (default False) 🚫🌈
  • -q, --quiet — suppress normal output 🤫
  • -s, --silent — only print errors. nothing else. silence. 🙈
  • -v, --verbose — print additional information 👀
  • --version — version for apptainer ⭐

👑 Available Commands:

these are the girlies. the whole squad. let's meet them:

  • build — Build an Apptainer image 🏗️
  • cache — Manage the local cache 📦
  • capability — Manage Linux capabilities for users and groups 🔐
  • checkpoint — Manage container checkpoint state (experimental!! careful bestie) ⚠️
  • 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 🌈

here's exactly how you'd use it, no guessing:

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

and for additional help or support, please visit https://apptainer.org/help/ 🫶

ngl, that's the whole page. go forth and containerize, bestie 💅

signing off in true icon fashion: this was singularity.apptainer version 1.4.5-2u..., dated August 2026. periodt. 🎀✨

📦 where this page comes from