Skip to content

Authentication

Commands for managing user identity and verifying system connectivity.

register

Register a new user account with the authentication server.

bash
vmr register [OPTIONS]

Options

FlagShortDescription
--username <USERNAME>-uUsername (prompts interactively if omitted)
--password <PASSWORD>-pPassword (prompts securely if omitted)

Examples

bash
vmr register -u myuser -p mypassword

vmr register
# Username: myuser
# Password: ********

TIP

When no flags are provided, the CLI prompts for credentials interactively. The password prompt uses secure input that does not echo characters to the terminal.

login

Log in to the registry and store credentials locally. The access token is persisted on disk so subsequent commands can authenticate automatically.

bash
vmr login [OPTIONS]

Options

FlagShortDescription
--username <USERNAME>-uUsername (prompts interactively if omitted)
--password <PASSWORD>-pPassword (prompts securely if omitted)

Examples

bash
vmr login -u myuser -p mypassword

vmr login
# Username: myuser
# Password: ********

The login request is forwarded by the daemon to the auth server at the URL configured via VM_AUTH_SERVER_URL (or the active context's auth_server_url). On success, the returned JWT access token is saved in the local credential store.

logout

Log out from the registry and clear locally stored credentials. The daemon also notifies the auth server to revoke the associated refresh token.

bash
vmr logout

Examples

bash
vmr logout

ping

Check the health of the daemon, the registry server, and the authentication server. Reports latency for each reachable service.

bash
vmr ping

Response Fields

FieldDescription
statusOverall health status
auth_latency_msRound-trip time to the auth server in milliseconds
registry_latency_msRound-trip time to the registry server in milliseconds
timestampServer-side timestamp of the health check

Examples

bash
vmr ping

Built with Go and Rust