Package singularity

Application and environment virtualization

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

General Commands

singularity Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC)
singularity-build Build a Singularity image
singularity-cache Manage the local cache
singularity-cache-clean Clean your local Singularity cache
singularity-cache-list List your local Singularity cache
singularity-capability Manage Linux capabilities for users and groups
singularity-capability-add Add capabilities to a user or group (requires root)
singularity-capability-avail Show description for available capabilities
singularity-capability-drop Remove capabilities from a user or group (requires root)
singularity-capability-list Show capabilities for a given user or group
singularity-config Manage various singularity configuration (root user only)
singularity-config-fakeroot Manage fakeroot user mappings entries (root user only)
singularity-config-global Edit singularity.conf from command line (root user only)
singularity-delete Deletes requested image from the library
singularity-exec Run a command within a container
singularity-inspect Show metadata for an image
singularity-instance Manage containers running as services
singularity-instance-list List all running and named Singularity instances
singularity-instance-start Start a named instance of the given container image
singularity-instance-stop Stop a named instance of a given container image
singularity-key Manage OpenPGP keys
singularity-key-export Export a public or private key into a specific file
singularity-key-import Import a local key into the local keyring
singularity-key-list List keys in your local keyring
singularity-key-newpair Create a new key pair
singularity-key-pull Download a public key from a key server
singularity-key-push Upload a public key to a key server
singularity-key-remove Remove a local public key from your keyring
singularity-key-search Search for keys on a key server
singularity-oci Manage OCI containers
singularity-oci-attach Attach console to a running container process (root user only)
singularity-oci-create Create a container from a bundle directory (root user only)
singularity-oci-delete Delete container (root user only)
singularity-oci-exec Execute a command within container (root user only)
singularity-oci-kill Kill a container (root user only)
singularity-oci-mount Mount create an OCI bundle from SIF image (root user only)
singularity-oci-pause Suspends all processes inside the container (root user only)
singularity-oci-resume Resumes all processes previously paused inside the container (root user only)
singularity-oci-run Create/start/attach/delete a container from a bundle directory (root user only)
singularity-oci-start Start container process (root user only)
singularity-oci-state Query state of a container (root user only)
singularity-oci-umount Umount delete bundle (root user only)
singularity-oci-update Update container cgroups resources (root user only)
singularity-plugin Manage Singularity plugins
singularity-plugin-compile Compile a Singularity plugin
singularity-plugin-disable disable an installed Singularity plugin
singularity-plugin-enable Enable an installed Singularity plugin
singularity-plugin-inspect Inspect a singularity plugin (either an installed one or an image)
singularity-plugin-install Install a compiled Singularity plugin
singularity-plugin-list List installed Singularity plugins
singularity-plugin-uninstall Uninstall removes the named plugin from the system
singularity-pull Pull an image from a URI
singularity-push Upload image to the provided URI
singularity-remote Manage singularity remote endpoints
singularity-remote-add Create a new singularity remote endpoint
singularity-remote-list List all singularity remote endpoints that are configured
singularity-remote-login Log into a singularity remote endpoint using an authentication token
singularity-remote-remove Remove an existing singularity remote endpoint
singularity-remote-status Check the status of the singularity services at an endpoint
singularity-remote-use Set a singularity remote endpoint to be actively used
singularity-run Run the user-defined default command within a container
singularity-run-help Show the user-defined help for an image
singularity-search Search a Container Library for images
singularity-shell Run a shell within a container
singularity-sif siftool is a program for Singularity Image Format (SIF) file manipulation
singularity-sif-add Add a data object to a SIF file
singularity-sif-del Delete a specified object descriptor and data from SIF file
singularity-sif-dump Extract and output data objects from SIF files
singularity-sif-header Display SIF global headers
singularity-sif-info Display detailed information of object descriptors
singularity-sif-list List object descriptors from SIF files
singularity-sif-new Create a new empty SIF image file
singularity-sif-setprim Set primary system partition
singularity-sign Attach a cryptographic signature to an image
singularity-test Run the user-defined tests within a container
singularity-verify Verify cryptographic signatures attached to an image
singularity-version Show the version for Singularity