Skip to content

docs: add macOS first-run prerequisites to quick start #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
WuKongAI-CMU wants to merge 1 commit into from
Closed

docs: add macOS first-run prerequisites to quick start #905

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,25 @@ The sandbox image is approximately 2.4 GB compressed. During image push, the Doc
| macOS | Podman | Not supported yet. NemoClaw currently depends on OpenShell support for Podman on macOS. |
| Windows WSL | Docker Desktop (WSL backend) | Supported target path |

#### macOS first-run checklist

On a fresh macOS machine, install the prerequisites in this order:

1. Install Xcode Command Line Tools:

```bash
xcode-select --install
```

2. Install and start a supported container runtime:
- Docker Desktop
- Colima
3. Run the NemoClaw installer.

This avoids the two most common first-run failures on macOS:
- missing developer tools needed by the installer and Node.js toolchain
- Docker connection errors when no supported container runtime is installed or running

> **💡 Tip**
>
> 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.
Expand Down
Loading