installation.mdx

{/* SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: Apache-2.0 */}

Use this page when you are consuming a published NeMo Relay release from a package manager.

If you are working from a source checkout, validating unpublished changes, or contributing to the repository, use Development Setup instead.

Choose the package by the boundary you want NeMo Relay to own or observe:

• Install the CLI when a local coding-agent harness owns the invocation
• Install a language binding when your application owns the tool or LLM call
• Install an integration package when a supported framework or agent harness owns the boundary

After installation, use Quick Start to choose the matching runtime path. If a supported framework or agent harness owns the boundary, start from Supported Integrations.

CLI

Install the NeMo Relay CLI when you want the nemo-relay executable for coding-agent hook and LLM gateway observability.

Install the latest stable release:

pip install "nemo-relay[cli]"

The shell installer commands intentionally download the installer from main and install the latest stable CLI release. The version of this documentation page does not select the CLI version; set NEMO_RELAY_VERSION to install a specific release.

The Unix installer downloads the matching GitHub Release binary to $HOME/.local/bin. The PowerShell installer downloads nemo-relay.exe to %LOCALAPPDATA%\nemo-relay\bin, adds that directory to the persistent user PATH, and updates the installing PowerShell process. Newly opened shells inherit the persistent PATH change. Verify that the command is available:

nemo-relay --version

After installation, nemo-relay can also install persistent Claude Code and Codex integrations:

nemo-relay install claude-code
nemo-relay install codex

Refer to Coding Agent Installation for the persistent integration workflow.

Supported Platforms

Use the GNU target on glibc-based distributions such as Ubuntu, Debian, and RHEL. Use the musl target on Alpine Linux and other musl-based systems. The Unix shell installer intentionally selects the portable musl target on Linux. For package versions that publish the corresponding artifacts, pip and uv automatically select a target compatible with the host CPU and C library on supported platforms.

The installer reports the detected operating system and architecture when no matching asset exists. Intel macOS is not supported because no matching release asset is published.

For support across the core library, plugins, worker runtimes, and CLI assets, refer to the Support Matrix.

Installer Reference

curl -fsSL https://raw.githubusercontent.com/NVIDIA/NeMo-Relay/main/install.sh | NEMO_RELAY_VERSION=0.8.0 sh

curl -fsSL https://raw.githubusercontent.com/NVIDIA/NeMo-Relay/main/install.sh | sh -s -- --install-dir "$HOME/bin"

$env:NEMO_RELAY_VERSION = '0.8.0'
irm https://raw.githubusercontent.com/NVIDIA/NeMo-Relay/main/install.ps1 | iex

iwr https://raw.githubusercontent.com/NVIDIA/NeMo-Relay/main/install.ps1 -OutFile install.ps1
.\install.ps1 -InstallDir "$HOME\bin"

On Windows, Git Bash, MSYS, Cygwin, and MINGW shells can use the Unix command. They install the matching Windows .exe asset into the same %LOCALAPPDATA%\nemo-relay\bin default directory and invoke PowerShell to persist the Windows user PATH update.

Rerun the installer to upgrade or replace the existing binary. It verifies the new download before replacing the binary in the selected installation directory.

Alternative Installation Methods

The PyPI and installer methods install the same CLI release with a binary compatible with the host platform. Use Cargo on unsupported platforms or when you prefer to build from source:

cargo install nemo-relay-cli

If you already use cargo-binstall, it can download the same published release asset through the Cargo interface:

cargo binstall nemo-relay-cli

For source installation and unsupported-platform guidance, refer to the CLI README.

Python

Install the Python package when your application uses NeMo Relay through the Python wrapper and owns the tool or LLM call boundary.

uv add nemo-relay@0.8.0

Use uv add from an application project that has a pyproject.toml; it records nemo-relay as a project dependency. If you are only installing into an active virtual environment and do not have project metadata, use uv pip install nemo-relay instead. You can also use pip install nemo-relay if you are not managing the environment with uv.

NeMo Relay publishes CPython 3.11 ABI3 wheels for x86_64 and ARM64 Linux systems. On supported CPython 3.11 or newer environments, pip and uv select manylinux_2_17 for glibc 2.17 or newer or musllinux_1_2 for musl 1.2 or newer. Supported Alpine Linux environments do not need a --platform override or source build. Alpine environments outside this wheel coverage must use a supported Python version and build from source.

Node.js

Install the Node.js package when your application uses NeMo Relay through the JavaScript API and owns the tool or LLM call boundary.

npm install nemo-relay-node@0.8.0

On supported x64 and ARM64 Linux systems, npm automatically installs the native package for the host C library, including the musl package on Alpine Linux.

Rust

Add the Rust crates when your application uses NeMo Relay directly from Rust.

cargo add nemo-relay@0.8.0
cargo add nemo-relay-adaptive@0.8.0

• nemo-relay provides the core runtime APIs for scopes, middleware, subscribers, plugins, tool calls, and LLM calls.
• nemo-relay-adaptive provides adaptive runtime primitives and Redis-backed learning components when you want adaptive tuning behavior in Rust.

Integrations

Install integration packages when your application already uses one of the supported framework or agent harness surfaces.

OpenClaw

Install the OpenClaw plugin through OpenClaw so OpenClaw can register and manage the package:

openclaw plugins install npm:nemo-relay-openclaw@0.8.0
openclaw gateway restart

Use the package name nemo-relay-openclaw for installation. Use the plugin ID nemo-relay in OpenClaw configuration, inspection, and gateway status commands. See the OpenClaw Plugin Guide for configuration and verification steps.

Hermes Agent

Install Hermes Agent 0.18.2 or newer by following the official Hermes Agent installation guide. NeMo Relay is built into Hermes Agent. No separate NeMo Relay package, observability plugin, or Relay CLI setup is required. Hermes Agent understands NeMo Relay plugin configurations.

Python Framework Integrations

Install the Python package with the supported framework extras when your application uses LangChain, LangGraph, or Deep Agents.

uv add "nemo-relay[langchain,langgraph,deepagents]@0.8.0"

The extras install the NeMo Relay Python package plus the dependencies needed by the maintained public integrations. See Supported Integrations for guide links and support levels.