Skip to content

Commit 4e3660e

Browse files
authored
docs(readme): add cluster deploy, upgrading, and sandbox tooling sections (#66)
* Update README.md * docs(readme): add cluster deploy, upgrading, and sandbox tooling sections
1 parent 36e5b4e commit 4e3660e

1 file changed

Lines changed: 52 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
**NOTICE: Repository has moved to Github**
2+
3+
Please use https://github.com/NVIDIA/nv-agent-env
4+
15
# Navigator 🗺️
26

37
Navigator is the runtime environment for autonomous agents—the "Matrix" where they live, work, and verify.
@@ -11,27 +15,68 @@ It transforms the data center from a static deployment target into a continuous
1115
### Prerequisites
1216

1317
- **Docker** — Docker Desktop (or a Docker daemon) must be running.
14-
- **Python 3.12+** and [uv](https://docs.astral.sh/uv/)
18+
- **Python 3.12+**
19+
- [**uv**](https://docs.astral.sh/uv/) 0.9+
1520

1621
### Install
1722

1823
```bash
19-
uv pip install nemoclaw --upgrade --pre --index-url https://urm.nvidia.com/artifactory/api/pypi/nv-shared-pypi/simple
24+
uv pip install nemoclaw \
25+
--upgrade \
26+
--pre \
27+
--index-url https://urm.nvidia.com/artifactory/api/pypi/nv-shared-pypi/simple
2028
```
2129

22-
The `navigator` binary is installed into your Python environment. Use `uv run navigator` to invoke it, or activate your venv first (`source .venv/bin/activate`).
30+
The `navigator` binary is installed into your Python environment. Use `uv run navigator` to invoke it, or activate your venv first with `source .venv/bin/activate`.
2331

2432
### Create a sandbox
2533

34+
To install a Openclaw cluster and start a sandbox
35+
2636
```bash
27-
uv run navigator sandbox create -- claude # or opencode or codex
37+
navigator sandbox create -- claude # or opencode or codex
2838
```
2939

30-
If you want to run a sandbox on a remote machine, pass `--remote [remote-ssh-host]`. This will start a sandbox on the remote host.
40+
To run a sandbox on a remote machine, pass `--remote [remote-ssh-host]`.
41+
42+
For more information see `navigator sandbox create --help`.
43+
44+
The sandbox container includes the following tools by default:
45+
46+
| Category | Tools |
47+
| ---------- | -------------------------------------------------------- |
48+
| Agent | `claude`, `opencode`, `codex` |
49+
| Language | `python` (3.12), `node` (22) |
50+
| Developer | `gh`, `git`, `vim`, `nano` |
51+
| Networking | `ping`, `dig`, `nslookup`, `nc`, `traceroute`, `netstat` |
3152

32-
The sandbox container includes a minimal networking toolset by default: `ping`, `dig`, `nslookup`, `nc`, `traceroute`, and `netstat`.
53+
For additional sandbox images see the [NVIDIA/NemoClaw-Community](https://github.com/NVIDIA/NemoClaw-Community) images. You can also [build your own custom images](examples/bring-your-own-container.md).
54+
55+
### Deploy a cluster
56+
57+
**Note:** `navigator sandbox create` automatically deploys a cluster if one isn't already running.
58+
59+
To deploy a cluster explicitly:
60+
61+
```bash
62+
navigator cluster admin deploy
63+
```
64+
65+
For remote deployment:
66+
67+
```bash
68+
navigator cluster admin deploy --remote user@host
69+
```
70+
71+
### Upgrading
72+
73+
To upgrade, redeploy your cluster to pick up the latest server and sandbox images:
74+
75+
```bash
76+
navigator cluster admin deploy
77+
```
3378

34-
It also includes common coding harnesses such as: `opencode`, `claude`, and `codex`.
79+
This will prompt you to recreate the cluster. Select "yes" to recreate the cluster.
3580

3681
## Developing
3782

0 commit comments

Comments
 (0)