Installation
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:
Unix shell
Windows PowerShell
These 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:
After installation, nemo-relay can also install persistent Claude Code and
Codex host plugins:
Refer to Plugin Installation for the host plugin workflow.
The installers download the published SHA-256 checksum for the selected release
asset and fail without replacing an existing binary if verification does not
succeed. They do not invoke sudo. The PowerShell installer updates the Windows
user PATH; the Unix installer does not edit shell configuration.
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.
Installer Reference
Unix shell
Windows PowerShell
Install a specific version:
Install into another directory:
Add the selected directory to PATH before running nemo-relay if it is not
already present.
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
Use the installers on a supported platform when you want a prebuilt release asset. Use Cargo on unsupported platforms or when you prefer to build from source:
If you already use cargo-binstall, it can download the same published release
asset through the Cargo interface:
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.
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.
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.
Rust
Add the Rust crates when your application uses NeMo Relay directly from Rust.
nemo-relayprovides the core runtime APIs for scopes, middleware, subscribers, plugins, tool calls, and LLM calls.nemo-relay-adaptiveprovides 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:
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 the latest NeMo Relay Python package in the environment that runs Hermes, then enable the bundled Hermes plugin:
The plugin ID is observability/nemo_relay. See the
Hermes NeMo Relay plugin guide
for configuration and verification steps.
Python Framework Integrations
Install the Python package with the supported framework extras when your application uses LangChain, LangGraph, or Deep Agents.
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.