Skip to content

installation.mdx

Latest commit

 

History

History
116 lines (83 loc) · 3.59 KB

installation.mdx

File metadata and controls

116 lines (83 loc) · 3.59 KB
Raw
title Installation
description
position 3

{/* 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.

cargo install nemo-relay-cli@0.5.0

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

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

See Plugin Installation for the host plugin workflow.

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.5.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.

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

Rust

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

cargo add nemo-relay@0.5.0
cargo add nemo-relay-adaptive@0.5.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.5.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.

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.5.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.