Command Line Client

Singularity Python exposes a command line client, shub, to make accessing some of the functions more easily. If you want to create, import, or generally work with images, you will still be best to use Singularity natively. This client has the following command groups:

usage: shub [-h] [--version] [--debug] [--size SIZE]
            {package,compare,analysis,create,inspect} ...

Singularity Hub command line tools

optional arguments:
  -h, --help            show this help message and exit
  --version             show software version
  --debug               use verbose logging to debug.
  --size SIZE           If using Docker or shub image, you can change size
                        (default is 1024)

actions:
  actions for Singularity Hub tools

  {package,compare,analysis,create,inspect}
                        shub actions
    package             package a container
    compare             views and functions to compare two containers
    analysis            estimate OS, container metrics, and generate container
                        tags.
    create              create recipe templates
    inspect             inspect a single container.

create: can create a blank recipe file to start your container recipe