CLI & automation
Jump to the nr CLI docs for install, auth, service accounts, and cluster register
The nr CLI is the automation path for registering and operating provider agent clusters. Full documentation lives in its own section, structured for learning, tasks, lookup, and deeper understanding.
CLI overview
What nr is and how the docs are organized.
Tutorial: first agent
Install, sign in, register, and verify in one path.
Automate with CI
Service account tokens and non-interactive register.
Command reference
Flags, config, environment variables, exit codes.
Quick links inside provider guides
| Topic | Guide |
|---|---|
| What the agent installs | Agents |
| Lifecycle hook scripts | Hook Scripts |
| Roles and service accounts | Access control |
| Full marketplace onboarding | Get started (Proxmox) · Get started (VirtFusion) · Get started (SolusVM 2) |
| Connect failures | Troubleshooting |
export NR_API_TOKEN='<service-account-token>'
echo $NR_API_TOKEN
nr cluster register \
--name edge-ams-01 \
--agent-ip 203.0.113.10 \
--gateway-region AMS01 \
--org-id <org-uuid>
nr cluster verify --name edge-ams-01 --org-id <org-uuid>