Command catalog
Exhaustive list of nr top-level commands and subcommands
Binary name: nr. Run nr <command> --help for the live flag list on your installed version.
| Flag | Description |
|---|
--api-url | Override API base URL (highest precedence) |
--config-dir | Override config directory (default ~/.nr) |
--org-id | Organization UUID (X-Organization-ID; required for nr cluster register) |
--help | Help for any command |
--version | Print version / commit / build date |
| Command | Description |
|---|
nr auth login | Browser OAuth login (PKCE) |
nr auth status | Show authentication status (--output text|json) |
nr auth refresh | Refresh the OAuth access token |
nr auth logout | Remove stored tokens |
nr auth set-token | Store a service account JWT (--token or --from-env) |
| Command | Description |
|---|
nr agent create | Create an agent record (--name, --agent-ip, --gateway-region) |
nr agent list | List agents |
nr agent get | Get one agent (--agent-id or --name) |
nr agent update | Update name/description (--set-name, --description) |
nr agent delete | Delete agent (--force skips confirm) |
Creating an agent record alone does not install k3s/Liqo. Prefer nr cluster register for full bootstrap.
| Command | Description |
|---|
nr sa create | Create service account |
nr sa list | List service accounts |
nr sa get | Get by --id |
nr sa update | Update name, description, active flag, allowed IPs |
nr sa delete | Delete (--force skips confirm) |
nr sa token generate | Mint JWT (--service-account-id, --name, --expires-in-days) |
nr sa token list | List tokens for a service account |
nr sa token revoke | Revoke by --token-id |
nr sa role assign | Assign or clear role (--role-id empty clears) |
nr sa group add | Add service accounts to a group |
nr sa group remove | Remove service accounts from a group |
| Command | Description |
|---|
nr cluster register | Full install + peer + optional operator (flags) |
nr cluster verify | Post-register / standalone health gate |
nr cluster deregister | Uninstall local stack; optionally delete API agent |
nr cluster rollback | Roll back to last successful checkpoint |
nr cluster recover | Reconcile local state with installed cluster |
nr cluster reset | Clear checkpoints; keep agent identity |
| Command | Description |
|---|
nr cluster status | Phase and reachability |
nr cluster info | Metadata, versions, CIDRs |
nr cluster health | Component health checks |
nr cluster logs | Recent logs (--lines) |
nr cluster debug | Write debug bundle under ~/.nr/debug-<timestamp>/ |
Most cluster commands accept --name and/or --agent-id. Diagnostics and verify also accept --output text|json.