📦 apptainer-doc

198 pages

A

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

S

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