> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemoclaw/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemoclaw/_mcp/server.

# Architecture Details

> Learn how NemoClaw combines a host CLI, sandbox integration layer, and versioned blueprint to run compatible agents in controlled OpenShell sandboxes.

NemoClaw combines a host CLI, an in-sandbox integration layer, and a versioned YAML blueprint that defines the sandbox image, policies, and inference profiles applied through OpenShell.

## System Overview

NVIDIA OpenShell is a general-purpose agent runtime.
It provides sandbox containers, a credential-storing gateway, inference proxying, and policy enforcement, but it has no opinions about what runs inside.
NemoClaw is an opinionated reference stack built on OpenShell that handles what goes in the sandbox, prepares agent-specific integration, and makes the setup accessible.

```mermaid
graph LR
    classDef nemoclaw fill:#76b900,stroke:#5a8f00,color:#fff,stroke-width:2px,font-weight:bold
    classDef openshell fill:#1a1a1a,stroke:#1a1a1a,color:#fff,stroke-width:2px,font-weight:bold
    classDef sandbox fill:#444,stroke:#76b900,color:#fff,stroke-width:2px,font-weight:bold
    classDef agent fill:#f5f5f5,stroke:#e0e0e0,color:#1a1a1a,stroke-width:1px
    classDef external fill:#f5f5f5,stroke:#e0e0e0,color:#1a1a1a,stroke-width:1px
    classDef user fill:#fff,stroke:#76b900,color:#1a1a1a,stroke-width:2px,font-weight:bold

    USER(["👤 User"]):::user

    subgraph EXTERNAL["External Services"]
        INFERENCE["Inference Provider<br /><small>NVIDIA Endpoints · OpenAI<br />Anthropic · Ollama · vLLM · Model Router</small>"]:::external
        INTEGRATIONS["Integration APIs<br /><small>MCP · GitHub · package indexes</small>"]:::external
        INTERNET["Internet<br /><small>PyPI · npm · GitHub · APIs</small>"]:::external
    end

    subgraph HOST["Host Machine"]

        subgraph NEMOCLAW["NemoClaw"]
            direction TB
            NCLI["CLI + Onboarding<br /><small>Guided setup · provider selection<br />credential validation · deploy</small>"]:::nemoclaw
            BP["Blueprint<br /><small>Hardened Dockerfile<br />Network policies · Presets<br />Security configuration</small>"]:::nemoclaw
            MIGRATE["State Management<br /><small>Migration snapshots<br />Credential stripping<br />Integrity verification</small>"]:::nemoclaw
        end

        subgraph OPENSHELL["OpenShell"]
            direction TB
            GW["Gateway<br /><small>Credential store<br />Inference proxy<br />Policy engine<br />Device auth</small>"]:::openshell
            OSCLI["openshell CLI<br /><small>provider · sandbox<br />gateway · policy</small>"]:::openshell
            INTEG["Managed integrations<br /><small>MCP · credentials · policy</small>"]:::openshell

            subgraph SANDBOX["Sandbox Container 🔒"]
                direction TB
                AGENT["Compatible Agent<br /><small>Selected managed runtime</small>"]:::agent
                PLUG["NemoClaw Integration<br /><small>Managed configuration<br />and runtime context</small>"]:::sandbox
            end
        end
    end

    USER -->|"nemo-deepagents onboard<br />nemo-deepagents connect"| NCLI
    USER -->|"Tasks and approvals"| NCLI

    NCLI -->|"Orchestrates"| OSCLI
    BP -->|"Defines sandbox<br />shape + policies"| SANDBOX
    MIGRATE -->|"Safe state<br />transfer"| SANDBOX

    AGENT -->|"Inference requests<br /><small>no credentials</small>"| GW
    GW -->|"Proxied with<br />credential injected"| INFERENCE

    INTEGRATIONS -->|"External APIs"| INTEG
    INTEG -->|"Policy-gated access"| AGENT

    AGENT -.->|"Policy-gated"| INTERNET
    GW -.->|"Enforced by<br />gateway"| INTERNET
```

## Deployment Topology

The logical diagram above shows how components relate.
This section shows what actually runs where on the host.
NemoClaw's default Docker-driver topology does not place the sandbox in an embedded k3s cluster.
On Linux, NemoClaw configures and restarts the package-managed OpenShell gateway user service when it is installed, then creates the sandbox as a Docker container.
NemoClaw treats that service as authoritative only when `systemctl --user show openshell-gateway` reports a package/vendor unit path and an `openshell-gateway` `ExecStart`.
Per-user units, partial units, and user-manager or bus outages do not take over gateway ownership; NemoClaw falls back to the standalone gateway process used by earlier installs.
That compatibility fallback remains until supported upgrade paths no longer include pre-service OpenShell installs and the package-managed handoff has direct nightly coverage.
On Apple Silicon macOS, NemoClaw starts the OpenShell Docker-driver gateway and creates the sandbox as a Docker container.
In both Docker-driver modes, the sandbox is a Docker container, not a Kubernetes pod.
The in-container `/tmp/nemoclaw-gateway-local` marker is written only by entrypoint paths that actually launch an in-container gateway.
Terminal runtimes may not write it.
NemoClaw does not treat sandbox environment hints such as `OPENSHELL_DRIVERS` as authoritative for gateway ownership.
Legacy non-Docker-driver installs still use the k3s-based gateway path; the diagram below shows the standard Docker-driver topology.

```mermaid
graph TB
    classDef host fill:#fff,stroke:#76b900,stroke-width:2px,color:#1a1a1a,font-weight:bold
    classDef cli fill:#76b900,stroke:#5a8f00,color:#fff,stroke-width:2px,font-weight:bold
    classDef docker fill:#2496ed,stroke:#1577c2,color:#fff,stroke-width:2px,font-weight:bold
    classDef gateway fill:#1a1a1a,stroke:#1a1a1a,color:#fff,stroke-width:2px,font-weight:bold
    classDef sandbox fill:#444,stroke:#76b900,color:#fff,stroke-width:2px
    classDef external fill:#f5f5f5,stroke:#e0e0e0,color:#1a1a1a,stroke-width:1px

    subgraph HOST["Host machine · Linux / Apple Silicon macOS / DGX Spark / DGX Station"]
        direction TB
        CLI["nemo-deepagents CLI<br /><small>bin/nemoclaw.js → dist/<br />onboard · connect · status · logs</small>"]:::cli
        GW["OpenShell gateway<br /><small>host process by default<br />credential store · lifecycle · L7 proxy</small>"]:::gateway

        subgraph DOCKER["Docker daemon"]
            direction TB
            SANDBOX["Sandbox container 🔒<br /><small>Landlock + seccomp + netns<br />Compatible agent + NemoClaw integration</small>"]:::sandbox
        end
    end

    INFER["Inference provider<br /><small>NVIDIA Endpoints · OpenAI<br />Anthropic · Ollama · vLLM · Model Router</small>"]:::external

    CLI -->|"openshell CLI<br />(orchestrates)"| GW
    GW -->|"creates/recreates<br />Docker-driver sandbox"| SANDBOX
    SANDBOX -->|"inference requests<br /><small>placeholder credentials</small>"| GW
    GW -->|"egress with real credentials<br />injected at the L7 proxy"| INFER

    class HOST host
    class DOCKER docker
    class GW gateway
    class SANDBOX sandbox
```

Layering from top to bottom:

| Layer              | Runs as                                                                                                        | Role                                                                                                                                                   |
| ------------------ | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Host CLI           | Host process (`nemo-deepagents` on Node.js)                                                                    | Orchestrates OpenShell via `openshell` CLI calls.                                                                                                      |
| OpenShell gateway  | Host process by default; optional Linux compatibility container when the gateway binary needs a newer host ABI | Hosts the credential store, owns sandbox lifecycle coordination, and provides the L7 proxy.                                                            |
| Docker daemon      | Host service                                                                                                   | Runs the Docker-driver sandbox container and, on affected Linux hosts, the optional gateway compatibility container.                                   |
| Sandbox container  | Docker container                                                                                               | Runs the selected compatible agent and NemoClaw integration under Landlock + seccomp + netns.                                                          |
| OpenShell L7 proxy | Gateway process                                                                                                | Intercepts agent egress and rewrites `Authorization` headers (Bearer/Bot) and URL-path segments to inject the real credential at the network boundary. |

NemoClaw never gives the sandbox a raw provider key.
At onboard time it registers credentials with OpenShell's provider/placeholder system, and the L7 proxy substitutes the real value into outbound requests at egress.
The CLI helper `isInferenceRouteReady` (in `src/lib/onboard.ts`) is a host-side readiness check used by the resume flow to decide whether the active route already covers the chosen provider and model.
It is not a runtime component.

For the DGX Spark-specific variant of this topology (cgroup v2, aarch64, unified memory), refer to the [NVIDIA Spark playbook](https://build.nvidia.com/spark/nemoclaw).

## NemoClaw Agent Integration

NemoClaw integrates with each supported agent through a runtime layer that adapts the agent to OpenShell-managed providers, policies, and sandbox state.
The concrete files differ by agent because each runtime has its own plugin system, config format, state layout, and startup command.

| Agent | Integration files | Runtime behavior |
| ----- | ----------------- | ---------------- |

\| Deep Agents | `agents/langchain-deepagents-code/manifest.yaml`, `agents/langchain-deepagents-code/generate-config.ts`, `agents/langchain-deepagents-code/start.sh`, and the managed `dcode` launchers | Declares the terminal agent contract, writes `/sandbox/.deepagents/config.toml`, installs managed wrappers for `dcode` and `dcode -n`, and routes inference through `inference.local`. |

The Deep Agents integration follows the generic agent-manifest path for terminal runtimes.
The manifest declares the `dcode` binary, smoke checks, config directory, state directories, and OpenAI-compatible inference route.
The build-time config generator turns NemoClaw onboarding choices into `config.toml`, and the managed launchers enforce the supported credential, MCP, tracing, and sandbox boundaries before `dcode` starts.

## NemoClaw Blueprint

The blueprint is a versioned YAML package with its own release stream.
The runner resolves, verifies, and applies the blueprint through the OpenShell CLI.
The blueprint defines the sandbox shape, default policies, and inference profiles; the runner performs the OpenShell operations.

```text
nemoclaw-blueprint/
├── blueprint.yaml                  Manifest: version, profiles, compatibility
├── model-specific-setup/           Agent-scoped model/provider compatibility manifests
├── router/                         Model Router config and routing engine
├── policies/
│   └── presets/                    Shared policy presets
```

Deep Agents keeps its agent-owned image, config generator, entrypoint, wrappers, and policy additions under `agents/langchain-deepagents-code/`.
The default Deep Agents policy starts from `agents/langchain-deepagents-code/policy-additions.yaml`.

The current blueprint runner implementation lives in the `nemoclaw/` TypeScript package:

```text
nemoclaw/src/blueprint/
├── runner.ts                       CLI runner: plan / apply / status / rollback
├── ssrf.ts                         SSRF endpoint validation (IP + DNS checks)
├── private-networks.ts             Shared private-network block list loader for SSRF checks
├── snapshot.ts                     Migration snapshot / restore lifecycle
├── state.ts                        Persistent run state management
```

### Blueprint Lifecycle

```mermaid
flowchart LR
    A[resolve] --> B[verify digest]
    B --> C[plan]
    C --> D[apply]
    D --> E[status]
```

1. Resolve. The integration layer locates the blueprint artifact and checks the version against the OpenShell and agent runtime constraints in `blueprint.yaml`.
2. Verify. The integration layer checks the artifact digest against the expected value.
3. Plan. The runner determines what OpenShell resources to create or update, such as the gateway, providers, sandbox, inference route, and policy.
4. Apply. The runner executes the plan by calling `openshell` CLI commands.
5. Status. The runner reports current state.

## Sandbox Environment

Deep Agents onboarding builds from the agent-specific `agents/langchain-deepagents-code/Dockerfile.base` image and layers the managed Deep Agents runtime Dockerfile on top.
That base installs Node, Python, shell tools, and the hash-locked `deepagents-code` package needed by the terminal harness.

Inside the sandbox:

* The selected compatible agent runs with the NemoClaw integration layer installed or generated for that agent.

* Inference calls are routed through OpenShell to the configured provider.

* Network egress is restricted by the baseline policy for the selected agent profile.

* Filesystem access is confined to `/sandbox` and `/tmp` for read-write access, with system paths read-only.

* NemoClaw writes generated Deep Agents configuration into the sandbox, then leaves interactive and headless execution to `dcode`.

* Deep Agents is a terminal runtime, so there is no long-running dashboard or gateway health surface inside the sandbox.

## Inference Routing

Inference requests from the agent never leave the sandbox directly.
OpenShell intercepts them and routes them to the configured provider:

```text
Compatible agent (sandbox)  ──▶  OpenShell gateway  ──▶  Provider endpoint
```

When you select the Model Router provider, the OpenShell gateway routes to a host-side router process instead of a single upstream model.
The router selects from the configured pool, then calls the upstream NVIDIA endpoint with the credential held outside the sandbox.

Some model and provider combinations need agent-specific compatibility setup.
NemoClaw keeps those declarations under `nemoclaw-blueprint/model-specific-setup/<agent>/` so fixes for each supported agent can be tested and reviewed independently.

Refer to [Inference Options](../inference/inference-options) for provider configuration details.

## Provider Credential Storage

Provider credentials live in the OpenShell gateway store, not on the host filesystem.
NemoClaw never writes them to host disk.
The OpenShell L7 proxy injects values at egress.
Refer to [Credential Storage](../security/credential-storage) for the inspection, rotation, and migration flow.

## Host-Side State and Config

NemoClaw keeps non-secret operator-facing state on the host rather than inside the sandbox.

| Path                         | Purpose                                                               |
| ---------------------------- | --------------------------------------------------------------------- |
| `~/.nemoclaw/sandboxes.json` | Registered sandbox metadata, including the default sandbox selection. |

The following environment variables configure optional services and local access.

| Variable | Purpose |
| -------- | ------- |

\| `NEMOCLAW_POLICY_TIER` | Optional non-interactive policy tier selection during onboarding. |
\| `TAVILY_API_KEY` | Host-side input for the optional managed Tavily provider. Register it with `nemo-deepagents credentials add tavily-search --type tavily --credential TAVILY_API_KEY` before attaching the provider to Deep Agents. |
\| `NEMOCLAW_GATEWAY_PORT` | Optional host-side gateway port override when running multiple independent OpenShell gateways. |

For normal setup and reconfiguration, prefer `nemo-deepagents onboard` over editing these files by hand.