Title: Basic Command Usage | Singularity
Description: Basic Command Usage These docs are for Singularity Version 2.5.2. For older versions, see our archive The Singularity commandSingularity uses a primary command wrapper called singularity. When you run singularity without any options or arguments it will dump the high level usage syntax.The general usage form is:$ singularity (opts1) [subcommand] (opts2) ...If you type singularity without any arguments, you will see a high level help for all arguments. The main options include:Container Actions build: Build a container on your user endpoint or build environment exec: Execute a command to your container inspect: See labels, run and test scripts, and environment variables pull: pull an image from Docker or Singularity Hub run: Run your image as an executable shell: Shell into your imageImage Commands image.import: import layers or other file content to your image image.export: export the contents of the image to tar or stream image.create: create a new image, using the old ext3 filesystem image.expand: increase the size of your image (old ext3)Instance CommandsInstances were added in 2.4. This list is brief, and likely to expand with further development. instances: Start, stop, and list container instancesDeprecated CommandsThe following commands are deprecated in 2.4 and will be removed in future releases. bootstrap: Bootstrap a container recipeFor the full usage, see the bottom of this pageOptions and argument processingBecause of the nature of how Singularity cascades commands and sub-commands, argument processing is done with a mandatory order. This means that where you place arguments is important! In the above usage example, opts1 are the global Singularity run-time options. These options are always applicable no matter what subcommand you select (e.g. --verbose or --debug). But subcommand specific options must be passed after the relevant subcommand.To further clarify this example, the exec Singularity subcommand will execute a program within the container and pass the arguments passed to the program. So to mitigate any argument clashes, Singularity must not interpret or interfere with any of the command arguments or options that are not relevant for that particular function.Singularity HelpSingularity comes with some internal documentation by using the help subcommand followed by the subcommand you want more information about. For example:$ singularity help createCREATE OPTIONS: -s/--size Specify a size for an operation in MiB, i.e. 1024*1024B (default 768MiB) -F/--force Overwrite an image file if it existsEXAMPLES: $ singularity create /tmp/Debian.img $ singularity create -s 4096 /tmp/Debian.imgFor additional help, please visit our public documentation pages which arefound at: http://singularity.lbl.gov/Commands UsageUSAGE: singularity [global options...]
Domain: singularityware.github.io
| None | IE=edge |
| name | Basic Command Usage |
| thumbnail | http://singularity.lbl.gov/images/logo/logo.svg |
Links:
Viewport: width=device-width, initial-scale=1
Robots: noindex