Skip to main content

signadot devbox

The devbox subcommand supports managing devboxes, which are entities associated with local connect sessions.

devbox register --name​

devbox register will register the device or Docker container on which it is run, creating a devbox associated with the authenticated user and the device or Docker container. Once created, the devbox identifier is stored in $HOME/.signadot/.devbox-id and used as the default for that user on that device or Docker container for subsequent calls to signadot local connect.

By default devbox ids are sticky and deterministic. The devbox id is a function of three pieces of information:

  1. A name which if not provided defaults to the hostname as returned by os.Hostname
  2. The local machine id
  3. The authenticated Signadot user's email associated with the call to signadot local connect, if any (api key authentication has no user's email associated).

devbox list [--all]​

devbox list will list devboxes. If the caller is authenticated as a Signadot user with role "member", then devbox list will list only devboxes either created by that user or which have been registered on the device or Docker container. Such a caller may add the --all flag to list all devboxes.

devbox delete​

devbox delete deletes a devbox when provided with a devbox identifier. If the caller is authenticated with role "member" and the provided identifier corresponds to a devbox created by another member or with an API key, then the deletion will fail.