Documentation ¶
Index ¶
Constants ¶
View Source
const ( // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // main singularity command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SingularityUse string = `singularity [global options...]` SingularityShort string = ` Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC)` SingularityLong string = `` /* 286-byte string literal not displayed */ SingularityExample string = ` $ singularity help <command> [<subcommand>] $ singularity help build $ singularity help instance start` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // build // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ BuildUse string = `build [local options...] <IMAGE PATH> <BUILD SPEC>` BuildShort string = `Build a Singularity image` BuildLong string = `` /* 1254-byte string literal not displayed */ BuildExample string = `` /* 3222-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Cache // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CacheUse string = `cache` CacheShort string = `Manage the local cache` CacheLong string = ` Manage your local Singularity cache. You can list/clean using the specific types.` CacheExample string = ` All group commands have their own help output: $ singularity cache $ singularity cache --help` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Cache clean // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CacheCleanUse string = `clean [clean options...]` CacheCleanShort string = `Clean your local Singularity cache` CacheCleanLong string = `` /* 383-byte string literal not displayed */ CacheCleanExample string = `` /* 180-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Cache List // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CacheListUse string = `list [list options...]` CacheListShort string = `List your local Singularity cache` CacheListLong string = ` This will list your local cache (stored at $HOME/.singularity/cache if SINGULARITY_CACHEDIR is not set).` CacheListExample string = `` /* 167-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyUse string = `key [key options...]` KeyShort string = `Manage OpenPGP keys` KeyLong string = `` /* 222-byte string literal not displayed */ KeyExample string = ` All group commands have their own help output: $ singularity help key newpair $ singularity key list --help` // keys is for the hidden 'keys' command KeysUse string = `keys [keys options...]` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key import // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyImportUse string = `import [import options...] <input-key>` KeyImportShort string = `Import a local key into the local or global keyring` KeyImportLong string = ` The 'key import' command allows you to add a key to your local or global keyring from a specific file.` KeyImportExample string = `` /* 138-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key export // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyExportUse string = `export [export options...] <output-file>` KeyExportShort string = `Export a public or private key into a specific file` KeyExportLong string = ` The 'key export' command allows you to export a key and save it to a file.` KeyExportExample string = `` /* 150-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key newpair // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyNewPairUse string = `newpair` KeyNewPairShort string = `Create a new key pair` KeyNewPairLong string = `` /* 177-byte string literal not displayed */ KeyNewPairExample string = `` /* 148-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key list // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyListUse string = `list` KeyListShort string = `List keys in your local or in the global keyring` KeyListLong string = ` List your local keys in your keyring. Will list public (trusted) keys by default.` KeyListExample string = ` $ singularity key list $ singularity key list --secret # list global public keys $ singularity key list --global` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key search // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeySearchUse string = `search [search options...] <search_string>` KeySearchShort string = `Search for keys on a key server` KeySearchLong string = `` /* 232-byte string literal not displayed */ KeySearchExample string = `` /* 192-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key pull // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyPullUse string = `pull [pull options...] <fingerprint>` KeyPullShort string = `Download a public key from a key server` KeyPullLong string = `` /* 416-byte string literal not displayed */ KeyPullExample string = ` $ singularity key pull 8883491F4268F173C6E5DC49EDECE4F3F38D871E` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key push // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyPushUse string = `push [push options...] <fingerprint>` KeyPushShort string = `Upload a public key to a key server` KeyPushLong string = `` /* 126-byte string literal not displayed */ KeyPushExample string = ` $ singularity key push 8883491F4268F173C6E5DC49EDECE4F3F38D871E` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // key remove // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyRemoveUse string = `remove <fingerprint>` KeyRemoveShort string = `Remove a local public key from your local or the global keyring` KeyRemoveLong string = ` The 'key remove' command will remove a local public key from the local or the global keyring.` KeyRemoveExample string = ` $ singularity key remove D87FE3AF5C1F063FCBCC9B02F812842B5EEE5934` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // delete // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ DeleteUse string = `delete [arch] <imageRef>` DeleteShort string = `Deletes requested image from the library` DeleteLong string = ` The 'delete' command allows you to delete an image from a remote library.` DeleteExample string = ` $ singularity delete --arch=amd64 library://username/project/image:1.0` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityUse string = `capability` CapabilityShort string = `Manage Linux capabilities for users and groups` CapabilityLong string = `` /* 427-byte string literal not displayed */ CapabilityExample string = ` All group commands have their own help output: $ singularity help capability add $ singularity capability add --help` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability add // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityAddUse string = `add [add options...] <capabilities>` CapabilityAddShort string = `Add capabilities to a user or group (requires root)` CapabilityAddLong string = `` /* 302-byte string literal not displayed */ CapabilityAddExample string = `` /* 227-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability drop // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityDropUse string = `drop [drop options...] <capabilities>` CapabilityDropShort string = `Remove capabilities from a user or group (requires root)` CapabilityDropLong string = `` /* 303-byte string literal not displayed */ CapabilityDropExample string = `` /* 228-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability list // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityListUse string = `list [user/group]` CapabilityListShort string = `Show capabilities for a given user or group` CapabilityListLong string = ` Show the capabilities for a user or group.` CapabilityListExample string = `` /* 172-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // capability avail // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CapabilityAvailUse string = `avail [capabilities]` CapabilityAvailShort string = `Show description for available capabilities` CapabilityAvailLong string = ` Show description for available Linux capabilities.` CapabilityAvailExample string = `` /* 259-byte string literal not displayed */ ExecUse string = `exec [exec options...] <container> <command>` ExecShort string = `Run a command within a container` ExecLong string = ` singularity exec supports the following formats:` + formats ExecExamples string = `` /* 364-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceUse string = `instance` InstanceShort string = `Manage containers running as services` InstanceLong string = `` /* 141-byte string literal not displayed */ InstanceExample string = ` All group commands have their own help output: $ singularity help instance start $ singularity instance start --help` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance list // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceListUse string = `list [list options...] [<instance name glob>]` InstanceListShort string = `List all running and named Singularity instances` InstanceListLong string = `` /* 131-byte string literal not displayed */ InstanceListExample string = `` /* 761-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance start // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceStartUse string = `start [start options...] <container path> <instance name> [startscript args...]` InstanceStartShort string = `Start a named instance of the given container image` InstanceStartLong string = ` The instance start command allows you to create a new named instance from an existing container image that will begin running in the background. If a startscript is defined in the container metadata the commands in that script will be executed with the instance start command as well. You can optionally pass arguments to startscript. singularity instance start accepts the following container formats` + formats InstanceStartExample string = `` /* 400-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance run // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceRunUse string = `run [start options...] <container path> <instance name> [runscript args...]` InstanceRunShort string = `Run a named instance of the given container image` InstanceRunLong string = ` The instance run command allows you to create a new named instance from an existing container image that will begin running in the background. If a runscript is defined in the container metadata the commands in that script will be executed with the instance run command as well. You can optionally pass arguments to runscript. NOTE: This command was added to Singularity significantly later than the other action commands and will not work with older containers. In that case, you may need to rebuild the container. singularity instance run accepts the following container formats` + formats InstanceRunExample string = `` /* 398-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance stats // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceStatsUse string = `stats [stats options...] <instance name>` InstanceStatsShort string = `Get stats for a named instance` InstanceStatsLong string = `` /* 332-byte string literal not displayed */ InstanceStatsExample string = `` /* 195-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // instance stop // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InstanceStopUse string = `stop [stop options...] [instance]` InstanceStopShort string = `Stop a named instance of a given container image` InstanceStopLong string = `` /* 128-byte string literal not displayed */ InstanceStopExample string = `` /* 548-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // pull // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ PullUse string = `pull [pull options...] [output file] <URI>` PullShort string = `Pull an image from a URI` PullLong string = `` /* 1153-byte string literal not displayed */ PullExample string = `` /* 551-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // push // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ PushUse string = `push [push options...] <image> <URI>` PushShort string = `Upload image to the provided URI` PushLong string = `` /* 426-byte string literal not displayed */ PushExample string = `` /* 196-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // search // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SearchUse string = `search [search options...] <search_query>` SearchShort string = `Search a Container Library for images` SearchLong string = `` /* 199-byte string literal not displayed */ SearchExample string = ` $ singularity search lolcow $ singularity search --arch arm64 alpine $ singularity search --signed tensorflow` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // run // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RunUse string = `run [run options...] <container>` RunShort string = `Run the user-defined default command within a container` RunLong string = ` This command will launch a Singularity container and execute a runscript if one is defined for that container. The runscript is a metadata file within the container that contains shell commands. If the file is present (and executable) then this command will execute that file within the container automatically. All arguments following the container name will be passed directly to the runscript. singularity run accepts the following container formats:` + formats RunExamples string = `` /* 352-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // shell // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ShellUse string = `shell [shell options...] <container>` ShellShort string = `Run a shell within a container` ShellLong string = ` singularity shell supports the following formats:` + formats ShellExamples string = `` /* 830-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // sign // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SignUse string = `sign [sign options...] <image path>` SignShort string = `Add digital signature(s) to an image` SignLong string = `` /* 313-byte string literal not displayed */ SignExample string = `` /* 133-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // verify // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ VerifyUse string = `verify [verify options...] <image path>` VerifyShort string = `Verify digital signature(s) within an image` VerifyLong string = `` /* 233-byte string literal not displayed */ VerifyExample string = `` /* 139-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Run-help // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RunHelpUse string = `run-help <image path>` RunHelpShort string = `Show the user-defined help for an image` RunHelpLong string = `` /* 173-byte string literal not displayed */ RunHelpExample string = `` /* 501-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Inspect // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ InspectUse string = `inspect [inspect options...] <image path>` InspectShort string = `Show metadata for an image` InspectLong string = `` /* 266-byte string literal not displayed */ InspectExample string = `` /* 2507-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Test // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RunTestUse string = `test [exec options...] <image path>` RunTestShort string = `Run the user-defined tests within a container` RunTestLong string = `` /* 450-byte string literal not displayed */ RunTestExample string = `` /* 301-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // OCI // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ OciUse string = `oci` OciShort string = `Manage OCI containers` OciLong string = ` Allow you to manage containers from OCI bundle directories. NOTE: all oci commands requires to run as root` OciExample string = `` /* 139-byte string literal not displayed */ OciCreateUse string = `create -b <bundle_path> [create options...] <container_ID>` OciCreateShort string = `Create a container from a bundle directory (root user only)` OciCreateLong string = ` Create invoke create operation to create a container instance from an OCI bundle directory` OciCreateExample string = ` $ singularity oci create -b ~/bundle mycontainer` OciStartUse string = `start <container_ID>` OciStartShort string = `Start container process (root user only)` OciStartLong string = ` Start invoke start operation to start a previously created container identified by container ID.` OciStartExample string = ` $ singularity oci start mycontainer` OciStateUse string = `state <container_ID>` OciStateShort string = `Query state of a container (root user only)` OciStateLong string = ` State invoke state operation to query state of a created/running/stopped container identified by container ID.` OciStateExample string = ` $ singularity oci state mycontainer` OciKillUse string = `kill [kill options...] <container_ID>` OciKillShort string = `Kill a container (root user only)` OciKillLong string = ` Kill invoke kill operation to kill processes running within container identified by container ID.` OciKillExample string = ` $ singularity oci kill mycontainer INT $ singularity oci kill mycontainer -s INT` OciDeleteUse string = `delete <container_ID>` OciDeleteShort string = `Delete container (root user only)` OciDeleteLong string = ` Delete invoke delete operation to delete resources that were created for container identified by container ID.` OciDeleteExample string = ` $ singularity oci delete mycontainer` OciAttachUse string = `attach <container_ID>` OciAttachShort string = `Attach console to a running container process (root user only)` OciAttachLong string = ` Attach will attach console to a running container process running within container identified by container ID.` OciAttachExample string = ` $ singularity oci attach mycontainer` OciExecUse string = `exec <container_ID> <command> <args>` OciExecShort string = `Execute a command within container (root user only)` OciExecLong string = ` Exec will execute the provided command/arguments within container identified by container ID.` OciExecExample string = ` $ singularity oci exec mycontainer id` OciRunUse string = `run -b <bundle_path> [run options...] <container_ID>` OciRunShort string = `Create/start/attach/delete a container from a bundle directory (root user only)` OciRunLong string = ` Run will invoke equivalent of create/start/attach/delete commands in a row.` OciRunExample string = `` /* 238-byte string literal not displayed */ OciUpdateUse string = `update [update options...] <container_ID>` OciUpdateShort string = `Update container cgroups resources (root user only)` OciUpdateLong string = ` Update will update cgroups resources for the specified container ID. Container must be in a RUNNING or CREATED state.` OciUpdateExample string = `` /* 190-byte string literal not displayed */ OciPauseUse string = `pause <container_ID>` OciPauseShort string = `Suspends all processes inside the container (root user only)` OciPauseLong string = ` Pause will suspend all processes for the specified container ID.` OciPauseExample string = ` $ singularity oci pause mycontainer` OciResumeUse string = `resume <container_ID>` OciResumeShort string = `Resumes all processes previously paused inside the container (root user only)` OciResumeLong string = ` Resume will resume all processes previously paused for the specified container ID.` OciResumeExample string = ` $ singularity oci resume mycontainer` OciMountUse string = `mount <sif_image> <bundle_path>` OciMountShort string = `Mount create an OCI bundle from SIF image (root user only)` OciMountLong string = ` Mount will mount and create an OCI bundle from a SIF image.` OciMountExample string = ` $ singularity oci mount /tmp/example.sif /var/lib/singularity/bundles/example` OciUmountUse string = `umount <bundle_path>` OciUmountShort string = `Umount delete bundle (root user only)` OciUmountLong string = ` Umount will umount an OCI bundle previously mounted with singularity oci mount.` OciUmountExample string = ` $ singularity oci umount /var/lib/singularity/bundles/example` ConfigUse string = `config` ConfigShort string = `Manage various singularity configuration (root user only)` ConfigLong string = ` The config command allows root user to manage various configuration like fakeroot user mapping entries.` ConfigExample string = `` /* 127-byte string literal not displayed */ ConfigFakerootUse string = `fakeroot <option> <user>` ConfigFakerootShort string = `Manage fakeroot user mappings entries (root user only)` ConfigFakerootLong string = ` The config fakeroot command allow a root user to add/remove/enable/disable fakeroot user mappings.` ConfigFakerootExample string = `` /* 411-byte string literal not displayed */ ConfigGlobalUse string = `global <option> <directive> [value,...]` ConfigGlobalShort string = `Edit singularity.conf from command line (root user only or unprivileged installation)` ConfigGlobalLong string = `` /* 138-byte string literal not displayed */ ConfigGlobalExample string = `` /* 551-byte string literal not displayed */ OverlayUse string = `overlay` OverlayShort string = `Manage an EXT3 writable overlay image` OverlayLong string = ` The overlay command allows management of EXT3 writable overlay images.` OverlayExample string = `` /* 126-byte string literal not displayed */ OverlayCreateUse string = `create <options> image` OverlayCreateShort string = `Create EXT3 writable overlay image` OverlayCreateLong string = `` /* 162-byte string literal not displayed */ OverlayCreateExample string = `` /* 385-byte string literal not displayed */ OverlaySyncUse string = `sync oci-sif` OverlaySyncShort string = `Sync OCI-SIF manifest & config with overlay content` OverlaySyncLong string = `` /* 166-byte string literal not displayed */ OverlaySyncExample string = ` To synchronize an OCI-SIF image containing an overlay: $ singularity overlay sync /tmp/overlay.oci.sif` OverlaySealUse string = `seal oci-sif` OverlaySealShort string = `Seal a writable overlay, into a read-only layer.` OverlaySealLong string = `` /* 215-byte string literal not displayed */ OverlaySealExample string = ` To seal an OCI-SIF image containing an overlay: $ singularity overlay seal /tmp/overlay.oci.sif` DataUse string = `data` DataShort string = `Manage an OCI-SIF data container` DataLong string = ` The data command allows management of OCI-SIF data containers.` DataExample string = ` All data commands have their own help output: $ singularity help data package $ singularity data package --help` DataPackageUse string = `package <source file/dir> <data container>` DataPackageShort string = `Package a file or directory into a data container` DataPackageLong string = `` /* 231-byte string literal not displayed */ DataPackageExample string = `` /* 227-byte string literal not displayed */ )
Global content for help and man pages
View Source
const ( SIFUse string = `sif` SIFAlias string = `siftool` SIFShort string = `Manipulate Singularity Image Format (SIF) images` SIFLong string = `` /* 223-byte string literal not displayed */ SIFExample string = ` All sif commands have their own help output: $ singularity help sif list $ singularity sif list --help` )
Documentation for sif/siftool command.
View Source
const ( // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // keyserver command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyserverUse string = `keyserver [subcommand options...]` KeyserverShort string = `Manage singularity keyservers` KeyserverLong string = ` The 'keyserver' command allows you to manage standalone keyservers that will be used for retrieving cryptographic keys.` KeyserverExample string = ` All group commands have their own help output: $ singularity help keyserver add $ singularity keyserver add` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // keyserver add command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyserverAddUse string = `add [options] [remoteName] <keyserver_url>` KeyserverAddShort string = `Add a keyserver (root user only)` KeyserverAddLong string = `` /* 403-byte string literal not displayed */ KeyserverAddExample string = `` /* 206-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // keyserver remove command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyserverRemoveUse string = `remove [remoteName] <keyserver_url>` KeyserverRemoveShort string = `Remove a keyserver (root user only)` KeyserverRemoveLong string = `` /* 205-byte string literal not displayed */ KeyserverRemoveExample string = ` $ singularity keyserver remove https://keys.example.com` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // keyserver login command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyserverLoginUse string = `login [login options...] <keyserver>` KeyserverLoginShort string = `Login to a keyserver` KeyserverLoginLong string = ` The 'keyserver login' command allows you to login to a specific keyserver.` KeyserverLoginExample string = ` To login in to a keyserver: $ singularity keyserver login --username foo https://mykeyserver.example.com` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // keyserver logout command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyserverLogoutUse string = `logout <keyserver>` KeyserverLogoutShort string = `Logout from a keyserver` KeyserverLogoutLong string = ` The 'keyserver logout' command allows you to log out from a keyserver.` KeyserverLogoutExample string = ` To log out from a keyserver: $ singularity keyserver logout https://mykeyserver.example.com` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // keyserver list command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ KeyserverListUse string = `list [remoteName]` KeyserverListShort string = `List all keyservers that are configured` KeyserverListLong string = `` /* 233-byte string literal not displayed */ KeyserverListExample string = ` $ singularity keyserver list` )
Global content for help and man pages
View Source
const ( PluginUse string = `plugin [plugin options...]` PluginShort string = `Manage Singularity plugins` PluginLong string = `` /* 142-byte string literal not displayed */ PluginExample string = ` All group commands have their own help output: $ singularity help plugin compile $ singularity plugin list --help` )
Plugin command usage.
View Source
const ( PluginCompileUse string = `compile [compile options...] <host_path>` PluginCompileShort string = `Compile a Singularity plugin` PluginCompileLong string = `` /* 393-byte string literal not displayed */ PluginCompileExample string = ` $ singularity plugin compile $HOME/singularity/test-plugin` )
Plugin compile command usage.
View Source
const ( PluginInstallUse string = `install <plugin_path>` PluginInstallShort string = `Install a compiled Singularity plugin` PluginInstallLong string = `` /* 283-byte string literal not displayed */ PluginInstallExample string = ` $ singularity plugin install $HOME/singularity/test-plugin/test-plugin.sif` )
Plugin install command usage.
View Source
const ( PluginUninstallUse string = `uninstall <name>` PluginUninstallShort string = `Uninstall removes the named plugin from the system` PluginUninstallLong string = ` The 'plugin uninstall' command removes the named plugin from the system` PluginUninstallExample string = ` $ singularity plugin uninstall example.org/plugin` )
Plugin uninstall command usage.
View Source
const ( PluginListUse string = `list [list options...]` PluginListShort string = `List installed Singularity plugins` PluginListLong string = ` The 'plugin list' command lists the Singularity plugins installed on the host.` PluginListExample string = ` $ singularity plugin list ENABLED NAME yes example.org/plugin` )
Plugin list command usage.
View Source
const ( PluginEnableUse string = `enable <name>` PluginEnableShort string = `Enable an installed Singularity plugin` PluginEnableLong string = `` /* 145-byte string literal not displayed */ PluginEnableExample string = ` $ singularity plugin enable example.org/plugin` )
Plugin enable command usage.
View Source
const ( PluginDisableUse string = `disable <name>` PluginDisableShort string = `disable an installed Singularity plugin` PluginDisableLong string = `` /* 146-byte string literal not displayed */ PluginDisableExample string = ` $ singularity plugin disable example.org/plugin` )
Plugin disable command usage.
View Source
const ( PluginInspectUse string = `inspect (<name>|<image>)` PluginInspectShort string = `Inspect a singularity plugin (either an installed one or an image)` PluginInspectLong string = `` /* 168-byte string literal not displayed */ PluginInspectExample string = `` /* 159-byte string literal not displayed */ )
Plugin inspect command usage.
View Source
const ( PluginCreateUse string = `create <host_path> <name>` PluginCreateShort string = `Create a plugin skeleton directory` PluginCreateLong string = `` /* 133-byte string literal not displayed */ PluginCreateExample string = `` /* 134-byte string literal not displayed */ )
Plugin create command usage.
View Source
const ( // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // registry command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RegistryUse string = `registry [subcommand options...]` RegistryShort string = `Manage authentication to OCI/Docker registries` RegistryLong string = `` /* 135-byte string literal not displayed */ RegistryExample string = ` All group commands have their own help output: $ singularity help registry login $ singularity registry login` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // registry login command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RegistryLoginUse string = `login [login options...] <registry_uri>` RegistryLoginShort string = `Login to an OCI/Docker registry` RegistryLoginLong string = ` The 'registry login' command allows you to login to a specific OCI/Docker registry.` RegistryLoginExample string = `` /* 592-byte string literal not displayed */ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // registry logout command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RegistryLogoutUse string = `logout <registry_uri>` RegistryLogoutShort string = `Logout from an OCI/Docker registry` RegistryLogoutLong string = ` The 'registry logout' command allows you to log out from an OCI/Docker registry.` RegistryLogoutExample string = ` To log out from an OCI/Docker registry $ singularity registry logout docker://docker.io` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // registry list command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RegistryListUse string = `list` RegistryListShort string = `List all OCI credentials that are configured` RegistryListLong string = ` The 'registry list' command lists all credentials for OCI/Docker registries that are configured for use.` RegistryListExample string = ` $ singularity registry list` )
Global content for help and man pages
View Source
const ( // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteUse string = `remote [remote options...]` RemoteShort string = `Manage singularity remote endpoints` RemoteLong string = `` /* 892-byte string literal not displayed */ RemoteExample string = ` All group commands have their own help output: $ singularity help remote list $ singularity remote list` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote get-login-password // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteGetLoginPasswordUse string = `get-login-password` //nolint:gosec RemoteGetLoginPasswordShort string = `Retrieves the cli secret for the currently logged in user` RemoteGetLoginPasswordLong string = `The 'remote get-login-password' command allows you to retrieve the cli secret for the currently user.` RemoteGetLoginPasswordExample string = `$ singularity remote get-login-password | docker login -u user --password-stdin https://harbor.sylabs.io` //nolint:gosec // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote add command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteAddUse string = `add [add options...] <remote_name> <remote_URI>` RemoteAddShort string = `Add a new singularity remote endpoint` RemoteAddLong string = `` /* 186-byte string literal not displayed */ RemoteAddExample string = ` $ singularity remote add SylabsCloud cloud.sylabs.io` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote remove command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteRemoveUse string = `remove [remove options...] <remote_name>` RemoteRemoveShort string = `Remove an existing singularity remote endpoint` RemoteRemoveLong string = `` /* 127-byte string literal not displayed */ RemoteRemoveExample string = ` $ singularity remote remove SylabsCloud` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote use command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteUseUse string = `use [use options...] <remote_name>` RemoteUseShort string = `Set a singularity remote endpoint to be actively used` RemoteUseLong string = ` The 'remote use' command sets the remote to be used by default by any command that interacts with Singularity services.` RemoteUseExample string = ` $ singularity remote use SylabsCloud` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote list command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteListUse string = `list` RemoteListShort string = `List all singularity remote endpoints that are configured` RemoteListLong string = `` /* 194-byte string literal not displayed */ RemoteListExample string = ` $ singularity remote list` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote login command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteLoginUse string = `login [login options...] <remote_name>` RemoteLoginShort string = `Login to a singularity remote endpoint` RemoteLoginLong string = `` /* 220-byte string literal not displayed */ RemoteLoginExample string = ` To log in to an endpoint: $ singularity remote login SylabsCloud` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote logout command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteLogoutUse string = `logout <remote_name>` RemoteLogoutShort string = `Log out from a singularity remote endpoint` RemoteLogoutLong string = `` /* 195-byte string literal not displayed */ RemoteLogoutExample string = ` To log out from an endpoint $ singularity remote logout SylabsCloud` // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // remote status command // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RemoteStatusUse string = `status [remote_name]` RemoteStatusShort string = `Check the status of the singularity services at an endpoint, and your authentication token` RemoteStatusLong string = `` /* 414-byte string literal not displayed */ RemoteStatusExample string = ` $ singularity remote status SylabsCloud` )
Global content for help and man pages #nosec G101
View Source
const ( HelpTemplate string = `` /* 598-byte string literal not displayed */ UseTemplate string = `` /* 231-byte string literal not displayed */ )
Global templates for help and usage strings
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.