# Functions
CheckRoot ensures that a command is executed with root privileges.
CheckRootOrUnpriv ensures that a command is executed with root privileges or that Singularity is installed unprivileged.
ExecuteSingularity adds all child commands to the root command and sets flags appropriately.
GenBashCompletion writes the bash completion file to w.
Init initializes and registers all singularity commands.
No description provided by the author
RootCmd returns the root singularity cobra command.
TraverseParentsUses walks the parent commands and outputs a properly formatted use string.
# Constants
Docker Registry protocol.
HTTPProtocol holds the remote http base URI.
HTTPSProtocol holds the remote https base URI.
LibraryProtocol holds the sylabs cloud library base URI, for more info refer to https://cloud.sylabs.io/library.
OrasProtocol holds the oras URI.
ShubProtocol holds singularity hub base URI, for more info refer to https://singularity-hub.org/.
# Variables
BuildConfigCmd outputs a list of the compile-time parameters with which singularity was compiled.
CacheCmd : aka, `singularity cache`.
CacheListCmd is 'singularity cache list' and will list your local singularity cache.
CapabilityAddCmd singularity capability add.
CapabilityAvailCmd singularity capability avail.
CapabilityCmd is the capability command.
CapabilityDropCmd singularity capability drop.
CapabilityListCmd singularity capability list.
CurrentUser holds the current user account information.
DataCmd is the 'data' command that provides management of data containers.
DataPackageCmd is the 'data package' command to package a file/dir into an OCI-SIF data container.
ExecCmd represents the exec command.
InspectCmd represents the 'inspect' command.
KeyCmd is the 'key' command that allows management of keyrings.
KeyExportCmd is `singularity key export` and exports a public or secret key from local keyring.
KeyNewPairCmd is 'singularity key newpair' and generate a new OpenPGP key pair.
KeyImportCmd is `singularity key (or keys) import` and imports a local key into the singularity keyring.
KeyListCmd is `singularity key list' and lists local store OpenPGP keys.
KeyNewPairCmd is 'singularity key newpair' and generate a new OpenPGP key pair.
KeyPullCmd is `singularity key pull' and fetches public keys from a key server.
KeyPushCmd is `singularity key list' and lists local store OpenPGP keys.
KeyRemoveCmd is `singularity key remove <fingerprint>' command.
KeySearchCmd is 'singularity key search' and look for public keys from a key server.
KeyserverAddCmd singularity keyserver add [option] <keyserver_url>.
KeyserverCmd singularity keyserver [...].
KeyserverListCmd singularity remote list.
KeyserverLoginCmd singularity registry login [option] <registry_url>.
KeyserverLogoutCmd singularity remote logout [remoteName|serviceURI].
KeyserverRemoveCmd singularity remote remove-keyserver [remoteName] <keyserver_url>.
OciAttachCmd represents oci attach command.
OciCmd singularity oci runtime.
OciCreateCmd represents oci create command.
OciDeleteCmd represents oci delete command.
OciExecCmd represents oci exec command.
OciKillCmd represents oci kill command.
OciMountCmd represents oci mount command.
OciPauseCmd represents oci pause command.
OciResumeCmd represents oci resume command.
OciRunCmd allow to create/start in row.
OciStartCmd represents oci start command.
OciStateCmd represents oci state command.
OciUmountCmd represents oci mount command.
OciUpdateCmd represents oci update command.
OverlayCmd is the 'overlay' command that allows to manage writable overlay.
OverlayCreateCmd is the 'overlay create' command that allows to create writable overlay.
OverlaySyncCmd is the 'overlay sync' command that updates the digest of an overlay in an OCI-SIF image, as recorded in the OCI manifest / config.
OverlaySyncCmd is the 'overlay sync' command that updates the digest of an overlay in an OCI-SIF image, as recorded in the OCI manifest / config.
PluginCmd is the root command for all plugin related functionality which is exposed via the CLI.
PluginCompileCmd allows a user to compile a plugin.
PluginCreateCmd creates a plugin skeleton directory structure to start developing a new plugin.
PluginDisableCmd disables the named plugin.
PluginEnableCmd enables the named plugin.
PluginInspectCmd displays information about a plugin.
PluginInstallCmd takes a compiled plugin.sif file and installs it in the appropriate location.
PluginListCmd lists the plugins installed in the system.
PluginUninstallCmd takes the name of a plugin and uninstalls it from the plugin directory.
PullCmd singularity pull.
PushCmd singularity push.
PushLibraryURI holds the base URI to a Sylabs library API instance.
RegistryCmd singularity registry [...].
RegistryListCmd singularity remote list.
RegistryLoginCmd singularity registry login [option] <registry_url>.
RegistryLogoutCmd singularity remote logout [remoteName|serviceURI].
RemoteAddCmd singularity remote add [remoteName] [remoteURI].
RemoteCmd singularity remote [...].
RemoteGetLoginPasswordCmd singularity remote get-login-password.
RemoteListCmd singularity remote list.
RemoteLoginCmd singularity remote login [remoteName].
RemoteLogoutCmd singularity remote logout [remoteName|serviceURI].
RemoteRemoveCmd singularity remote remove [remoteName].
RemoteStatusCmd singularity remote status [remoteName].
RemoteUseCmd singularity remote use [remoteName].
RunCmd represents the run command.
RunHelpCmd singularity run-help <image>.
SearchArch holds the architecture for images to display in search results.
SearchCmd singularity search.
SearchLibraryURI holds the base URI to a Sylabs library API instance.
SearchSigned is set true to only search for signed containers.
ShellCmd represents the shell command.
SignCmd singularity sign.
TestCmd represents the test command.
VerifyCmd singularity verify.
VersionCmd displays installed singularity version.