From 10aa44c64dbc5d424e41b2a3e693151e1cbf34a4 Mon Sep 17 00:00:00 2001 From: David Gardner Date: Wed, 8 Jul 2026 17:11:03 -0700 Subject: [PATCH 1/2] Seperate out the cargo bin path Signed-off-by: David Gardner --- docs/getting-started/overview.mdx | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/overview.mdx b/docs/getting-started/overview.mdx index 403be1a51..3a6dfd529 100644 --- a/docs/getting-started/overview.mdx +++ b/docs/getting-started/overview.mdx @@ -73,11 +73,23 @@ cargo install just --locked Refer to the [official installation guide](https://just.systems/man/en/installation.html) for more details. +Ensure that the Cargo bin directory is in your `PATH`: + +```bash +export PATH="$HOME/.cargo/bin:$PATH" +``` + +Create a Python virtual environment and activate it (replace `3.13` with your preferred Python version): + +```bash +uv venv -p 3.13 --seed .venv +source .venv/bin/activate +``` + Install the Python SDK with its native binding and the CLI from a source checkout: ```bash -export PATH="$HOME/.cargo/bin:$PATH" just build-all ``` From 1f0e00b9b13513065c09b8f01980f56b6d9beea8 Mon Sep 17 00:00:00 2001 From: David Gardner Date: Wed, 8 Jul 2026 17:12:11 -0700 Subject: [PATCH 2/2] Add an install guide Signed-off-by: David Gardner --- docs/getting-started/install.mdx | 82 ++++++++++++++++++++++++++++++++ docs/index.yml | 2 + 2 files changed, 84 insertions(+) create mode 100644 docs/getting-started/install.mdx diff --git a/docs/getting-started/install.mdx b/docs/getting-started/install.mdx new file mode 100644 index 000000000..4c8c04152 --- /dev/null +++ b/docs/getting-started/install.mdx @@ -0,0 +1,82 @@ +--- +title: "Install NeMo Fabric" +description: "Install guide." +--- +{/* SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. +SPDX-License-Identifier: Apache-2.0 */} + +# Install NeMo Fabric + +## Prerequisites: +- Rust and Cargo +- Python 3.11+ +- [uv](https://docs.astral.sh/uv/getting-started/installation/) +- `just` 1.50.0+ + +## Source Installation Method + +1. Create a Python virtual environment and activate it (replace `3.13` with your preferred Python version): + +```bash +uv venv -p 3.13 --seed .venv +source .venv/bin/activate +``` + +2. Build the Rust core and Python libraries. +```bash +just build-all +``` + +The above command will install only those dependencies that are strictly necessary for the build. +Alternately If you want to install all optional dependencies, you can run: + +```bash +uv sync --all-groups --all-extras +``` + +Then run the build command with the `no_uv=true` flag to avoid re-installing the dependencies: + +```bash +just build-all no_uv=true +``` + +## Package Installation Method + +Note: Fabric is currently not available on PyPI, as such for the time being wheels must first be built from source. + +Build the wheels from source: + +```bash +just wheels +``` + +This will create wheel files in the `dist` directory. + +### Installing Fabric Runtime + +This installs Fabric itself. + +```bash +uv pip install --find-links nemo-fabric[runtime] +``` + +### Installing the Fabric Adapters +This will install the Fabric adapter and it's dependencies, adapters intentionally have minimal dependencies, +and are intended to be installed in the same environment as the agent harness (which may or may not be the same environment as the Fabric runtime). + +At time of writing, the following adapter packages are available: +* adapters-codex-cli +* adapters-hermes-cli +* adapters-hermes-sdk + +```bash +uv pip install --find-links nemo-fabric[] +``` + +For example, to install the Hermes SDK adapter: + +```bash +uv pip install --find-links nemo-fabric[adapters-hermes-sdk] +``` + + diff --git a/docs/index.yml b/docs/index.yml index fb5da445f..1652d9b33 100644 --- a/docs/index.yml +++ b/docs/index.yml @@ -6,6 +6,8 @@ navigation: contents: - page: Overview path: ./getting-started/overview.mdx + - page: Install + path: ./getting-started/install.mdx - section: Guides contents: - page: Evaluate agents with Harbor