|
| 1 | +--- |
| 2 | +name: nemoclaw-get-started |
| 3 | +description: Installs NemoClaw, launch a sandbox, and run your first agent prompt. Use when inference routing, install nemoclaw openclaw sandbox, nemoclaw, nemoclaw quickstart, nemoclaw quickstart install launch, openclaw, openshell, sandboxing. |
| 4 | +--- |
| 5 | + |
| 6 | +# Nemoclaw Get Started |
| 7 | + |
| 8 | +Install NemoClaw, launch a sandbox, and run your first agent prompt. |
| 9 | + |
| 10 | +> **Alpha software:** NemoClaw is in alpha, available as an early preview since March 16, 2026. |
| 11 | +> APIs, configuration schemas, and runtime behavior are subject to breaking changes between releases. |
| 12 | +> Do not use this software in production environments. |
| 13 | +> File issues and feedback through the GitHub repository as the project continues to stabilize. |
| 14 | +
|
| 15 | +Follow these steps to get started with NemoClaw and your first sandboxed OpenClaw agent. |
| 16 | + |
| 17 | +> **Note:** NemoClaw currently requires a fresh installation of OpenClaw. |
| 18 | +
|
| 19 | +## Prerequisites |
| 20 | + |
| 21 | +Check the prerequisites before you start to ensure you have the necessary software and hardware to run NemoClaw. |
| 22 | + |
| 23 | +### Hardware |
| 24 | + |
| 25 | +| Resource | Minimum | Recommended | |
| 26 | +|----------|----------------|------------------| |
| 27 | +| CPU | 4 vCPU | 4+ vCPU | |
| 28 | +| RAM | 8 GB | 16 GB | |
| 29 | +| Disk | 20 GB free | 40 GB free | |
| 30 | + |
| 31 | +The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon, k3s, and the OpenShell gateway run alongside the export pipeline, which buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance. |
| 32 | + |
| 33 | +#### Software |
| 34 | + |
| 35 | +| Dependency | Version | |
| 36 | +|------------|----------------------------------| |
| 37 | +| Linux | Ubuntu 22.04 LTS or later | |
| 38 | +| Node.js | 20 or later | |
| 39 | +| npm | 10 or later | |
| 40 | +| Container runtime | Supported runtime installed and running | |
| 41 | +| [OpenShell](https://github.com/NVIDIA/OpenShell) | Installed | |
| 42 | + |
| 43 | +#### Container Runtime Support |
| 44 | + |
| 45 | +| Platform | Supported runtimes | Notes | |
| 46 | +|----------|--------------------|-------| |
| 47 | +| Linux | Docker | Primary supported path today | |
| 48 | +| macOS (Apple Silicon) | Colima, Docker Desktop | Recommended runtimes for supported macOS setups | |
| 49 | +| macOS | Podman | Not supported yet. NemoClaw currently depends on OpenShell support for Podman on macOS. | |
| 50 | +| Windows WSL | Docker Desktop (WSL backend) | Supported target path | |
| 51 | + |
| 52 | +> **💡 Tip** |
| 53 | +> |
| 54 | +> For DGX Spark, follow the [DGX Spark setup guide](https://github.com/NVIDIA/NemoClaw/blob/main/spark-install.md). It covers Spark-specific prerequisites, such as cgroup v2 and Docker configuration, before running the standard installer. |
| 55 | +
|
| 56 | +### Install NemoClaw and Onboard OpenClaw Agent |
| 57 | + |
| 58 | +Download and run the installer script. |
| 59 | +The script installs Node.js if it is not already present, then runs the guided onboard wizard to create a sandbox, configure inference, and apply security policies. |
| 60 | + |
| 61 | +```bash |
| 62 | +curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash |
| 63 | +``` |
| 64 | + |
| 65 | +If you use nvm or fnm to manage Node.js, the installer may not update your current shell's PATH. |
| 66 | +If `nemoclaw` is not found after install, run `source ~/.bashrc` (or `source ~/.zshrc` for zsh) or open a new terminal. |
| 67 | + |
| 68 | +When the install completes, a summary confirms the running environment: |
| 69 | + |
| 70 | +```text |
| 71 | +────────────────────────────────────────────────── |
| 72 | +Sandbox my-assistant (Landlock + seccomp + netns) |
| 73 | +Model nvidia/nemotron-3-super-120b-a12b (NVIDIA Endpoint API) |
| 74 | +────────────────────────────────────────────────── |
| 75 | +Run: nemoclaw my-assistant connect |
| 76 | +Status: nemoclaw my-assistant status |
| 77 | +Logs: nemoclaw my-assistant logs --follow |
| 78 | +────────────────────────────────────────────────── |
| 79 | +
|
| 80 | +[INFO] === Installation complete === |
| 81 | +``` |
| 82 | + |
| 83 | +### Chat with the Agent |
| 84 | + |
| 85 | +Connect to the sandbox, then chat with the agent through the TUI or the CLI. |
| 86 | + |
| 87 | +#### Connect to the Sandbox |
| 88 | + |
| 89 | +Run the following command to connect to the sandbox: |
| 90 | + |
| 91 | +```bash |
| 92 | +nemoclaw my-assistant connect |
| 93 | +``` |
| 94 | + |
| 95 | +This connects you to the sandbox shell `sandbox@my-assistant:~$` where you can run `openclaw` commands. |
| 96 | + |
| 97 | +#### OpenClaw TUI |
| 98 | + |
| 99 | +In the sandbox shell, run the following command to open the OpenClaw TUI, which opens an interactive chat interface. |
| 100 | + |
| 101 | +```bash |
| 102 | +openclaw tui |
| 103 | +``` |
| 104 | + |
| 105 | +Send a test message to the agent and verify you receive a response. |
| 106 | + |
| 107 | +> **ℹ️ Note** |
| 108 | +> |
| 109 | +> The TUI is best for interactive back-and-forth. If you need the full text of a long response such as a large code generation output, use the CLI instead. |
| 110 | +
|
| 111 | +#### OpenClaw CLI |
| 112 | + |
| 113 | +In the sandbox shell, run the following command to send a single message and print the response: |
| 114 | + |
| 115 | +```bash |
| 116 | +openclaw agent --agent main --local -m "hello" --session-id test |
| 117 | +``` |
| 118 | + |
| 119 | +This prints the complete response directly in the terminal and avoids relying on the TUI view for long output. |
| 120 | + |
| 121 | +### Uninstall |
| 122 | + |
| 123 | +To remove NemoClaw and all resources created during setup, in the terminal outside the sandbox, run: |
| 124 | + |
| 125 | +```bash |
| 126 | +curl -fsSL https://raw.githubusercontent.com/NVIDIA/NemoClaw/refs/heads/main/uninstall.sh | bash |
| 127 | +``` |
| 128 | + |
| 129 | +The script removes sandboxes, the NemoClaw gateway and providers, related Docker images and containers, local state directories, and the global `nemoclaw` npm package. It does not remove shared system tooling such as Docker, Node.js, npm, or Ollama. |
| 130 | + |
| 131 | +| Flag | Effect | |
| 132 | +|--------------------|-----------------------------------------------------| |
| 133 | +| `--yes` | Skip the confirmation prompt. | |
| 134 | +| `--keep-openshell` | Leave the `openshell` binary installed. | |
| 135 | +| `--delete-models` | Also remove NemoClaw-pulled Ollama models. | |
| 136 | + |
| 137 | +For example, to skip the confirmation prompt: |
| 138 | + |
| 139 | +```bash |
| 140 | +curl -fsSL https://raw.githubusercontent.com/NVIDIA/NemoClaw/refs/heads/main/uninstall.sh | bash -s -- --yes |
| 141 | +``` |
| 142 | + |
| 143 | +## Related Skills |
| 144 | + |
| 145 | +- `nemoclaw-configure-inference` — Switch inference providers to use a different model or endpoint |
| 146 | +- `nemoclaw-manage-policy` — Approve or deny network requests when the agent tries to reach external hosts |
| 147 | +- `nemoclaw-deploy-remote` — Deploy to a remote GPU instance for always-on operation |
| 148 | +- `nemoclaw-monitor-sandbox` — Monitor sandbox activity through the OpenShell TUI |
0 commit comments