singularity remote

Manage singularity remote endpoints


The ‘remote’ command allows you to manage Singularity remote endpoints through its subcommands.

A ‘remote endpoint’ is the Sylabs Cloud, a Singularity Enterprise installation, or a compatible group of services. The remote endpoint is a single address, e.g. ‘’ through which linked library, builder and keystore sevices will be automatically discovered.

To configure a remote endpoint you must ‘remote add’ it. You can ‘remote login’ if you will be performing actions needing authentication. Switch between configured remote endpoints with the ‘remote use’ command. The active remote endpoint will be used for remote builds, key operations, and ‘library://’ pull and push. You can also ‘remote logout’ from and ‘remote remove’ an endpoint that is no longer required.

The remote configuration is stored in $HOME/.singularity/remotes.yaml by default.


All group commands have their own help output:

  $ singularity help remote list
  $ singularity remote list


-c, --config string   path to the file holding remote endpoint configurations (default "/home/circleci/.singularity/remote.yaml")
-h, --help            help for remote


Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC) * singularity remote add - Add a new singularity remote endpoint * singularity remote get-login-password - Retrieves the cli secret for the currently logged in user * singularity remote list - List all singularity remote endpoints that are configured * singularity remote login - Login to a singularity remote endpoint * singularity remote logout - Log out from a singularity remote endpoint * singularity remote remove - Remove an existing singularity remote endpoint * singularity remote status - Check the status of the singularity services at an endpoint, and your authentication token * singularity remote use - Set a singularity remote endpoint to be actively used

Auto generated by spf13/cobra on 23-Nov-2023