NodeRingsDocs

Install the CLI

Install nr from GitHub Releases, from source, or with go install

Install the nr binary on the machine that will run agent registration (usually the agent VM).

Supported platforms

RequirementNotes
OS for cluster registerLinux (Ubuntu 22.04+ recommended)
Architecturesamd64 and arm64 release builds
Privilegessudo / root required to install k3s
NetworkHTTPS to api.noderings.com and GitHub Releases (tool downloads)

The CLI installs companion tools (liqoctl, helm) into ~/.nr/bin when they are missing or older than the versions pinned by the platform. You do not need to pre-install them for normal use.

  1. Open github.com/noderings/cli/releases.
  2. Download the archive for your OS and architecture.
  3. Verify the archive against checksums.txt on the same release.
  4. Extract and install:
tar -xzf nr_*.tar.gz
sudo install -m 0755 nr /usr/local/bin/nr
nr version

From source

Requires Go matching the version in the repository’s go.mod.

git clone https://github.com/noderings/cli.git
cd cli
make build
sudo install -m 0755 build/nr /usr/local/bin/nr
nr version

Using go install

go install github.com/noderings/cli/cmd/nr@latest

Ensure $(go env GOPATH)/bin is on your PATH.

Confirm the install

nr version
nr --help

Next: Authenticate.