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 CLI sends the credentials to the local daemon, which forwards them to the auth server it is configured to use. On success, the returned JWT access token is saved in the local credential store so subsequent commands authenticate automatically.

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. The CLI asks the daemon to run health checks and reports the response time for each reachable service.

bash
vmr ping

Output ​

ping prints a human-readable report. A healthy system looks like:

text
Running health checks...

Daemon is healthy! Response time: 1 ms
Registry is reachable! Response time: 12 ms
Auth server is reachable! Response time: 8 ms

Health check complete

If the daemon cannot be reached, the CLI falls back to probing the registry's /health endpoint directly and reports Daemon is unreachable. Each service line reports either its response time or that it is unreachable.

Examples ​

bash
vmr ping

Built with Go and Rust