mirror of
https://github.com/NVIDIA/OpenShell.git
synced 2026-11-05 08:36:09 +08:00
Roshni Malani
7c6623a8da
## Summary
- Rewrites the README quickstart with accurate, tested setup steps (Docker prerequisite, venv/uv usage)
- Moves the "developing from source" instructions into CONTRIBUTING.md
- Removes the manual cluster deploy step from quickstart (cluster bootstraps automatically on sandbox create)
- Fixes empty bash array expansion in Docker build scripts that broke on macOS default bash 3.2 (`set -u` treats `"${EMPTY_ARRAY[@]}"` as unbound)
## Changes
- **README.md**: Replace placeholder quickstart with working install and sandbox create steps; remove manual cluster deploy step since it happens automatically
- **CONTRIBUTING.md**: Add "developing from source" section with mise setup instructions
- **build/scripts/docker-build-cluster.sh**: Use `${arr[@]+"${arr[@]}"}` pattern for safe empty array expansion
- **build/scripts/docker-build-component.sh**: Same fix
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
# Navigator 🗺️
|
|
|
|
Navigator is the runtime environment for autonomous agents—the "Matrix" where they live, work, and verify.
|
|
|
|
While coding tools like Claude help agents write logic, Navigator provides the infrastructure to run it, offering a programmable factory where agents can spin up physics simulations to master tasks, generate synthetic data to fix edge cases, and safely iterate through thousands of failures in isolated sandboxes.
|
|
|
|
It transforms the data center from a static deployment target into a continuous verification engine, allowing agents to autonomously build and operate complex systems—from physical robotics to self-healing infrastructure—without needing a human to manage the infrastructure.
|
|
|
|
## Quickstart
|
|
|
|
### Prerequisites
|
|
|
|
- **Docker** — Docker Desktop (or a Docker daemon) must be running.
|
|
- **Python 3.12+** and [uv](https://docs.astral.sh/uv/)
|
|
|
|
### Install
|
|
|
|
```bash
|
|
uv pip install navigator --upgrade --pre --index-url https://urm.nvidia.com/artifactory/api/pypi/nv-shared-pypi/simple
|
|
```
|
|
|
|
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`).
|
|
|
|
### Create a sandbox
|
|
|
|
```bash
|
|
uv run navigator sandbox create -- claude # or opencode or codex
|
|
```
|
|
|
|
The sandbox container includes a minimal networking toolset by default: `ping`, `dig`, `nslookup`, `nc`, `traceroute`, and `netstat`.
|
|
|
|
## Developing
|
|
|
|
See `CONTRIBUTING.md` for building from source and contributing to Navigator.
|
|
|
|
## Architecture
|
|
|
|
See `architecture/` for detailed architecture docs and design decisions.
|