From d0b54367858ae546bec565257c7e4ae7ea1c0f9d Mon Sep 17 00:00:00 2001 From: zyang-dev <267119621+zyang-dev@users.noreply.github.com> Date: Tue, 19 May 2026 11:16:54 -0700 Subject: [PATCH 1/2] docs(get-started): document Windows bootstrap script option Signed-off-by: zyang-dev <267119621+zyang-dev@users.noreply.github.com> --- docs/get-started/windows-preparation.md | 33 ++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/get-started/windows-preparation.md b/docs/get-started/windows-preparation.md index c4afede1e8e..dddca6fd784 100644 --- a/docs/get-started/windows-preparation.md +++ b/docs/get-started/windows-preparation.md @@ -37,6 +37,36 @@ Verify the following before you begin: - Windows 10 (build 19041 or later) or Windows 11. - Hardware requirements are the same as the [Quickstart](quickstart.md). +## Option: Use the Bootstrap Script + +Open Windows PowerShell on the Windows host and run the bootstrap script: + +```console +$ Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/NVIDIA/NemoClaw/main/scripts/bootstrap-windows.ps1' -OutFile "$env:TEMP\bootstrap-windows.ps1"; powershell.exe -ExecutionPolicy Bypass -File "$env:TEMP\bootstrap-windows.ps1" +``` + +The command downloads the script to a temporary file before running it. +`-ExecutionPolicy Bypass` applies only to that PowerShell process and avoids local policy blocking the downloaded script. +Run it from Windows, not from inside WSL. +The script requests Administrator privileges when needed, enables the required WSL 2 Windows features, installs or opens Ubuntu, and installs and starts Docker Desktop. +If Ubuntu is already registered, the script confirms it uses WSL 2, converts it from WSL 1 when needed, and verifies Docker is reachable from WSL. +If Windows requires a reboot after enabling WSL features, the script prompts for the reboot and registers a one-time continuation for the next sign-in. +If Docker Desktop shows first-run prompts, complete them and return to the PowerShell window. + +For advanced options, download the script first and run `Get-Help "$env:TEMP\bootstrap-windows.ps1" -Detailed`. +Useful parameters include `-DistroName`, `-InstallerUrl`, `-InstallerArgs`, and `-InstallDockerDesktop`. + +The bootstrap script does not install NemoClaw itself. +When Windows preparation is complete, it opens Ubuntu and prints the standard installer command to run inside Ubuntu: + +```console +$ curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash +``` + +If the bootstrap script reports that Docker is not reachable from Ubuntu, open Docker Desktop Settings and confirm that WSL integration is enabled for Ubuntu (Settings > Resources > WSL integration), then rerun the script. + +The manual steps below describe the same Windows preparation pieces and are useful when you need to verify or repair WSL, Ubuntu, or Docker Desktop by hand. + ## Enable WSL 2 Open an elevated PowerShell (Run as Administrator): @@ -115,7 +145,8 @@ Use one instance, or move one of them to a different port before running `nemocl ## Next Step Your Windows environment is ready. -Open a WSL terminal (type `wsl` in PowerShell, or open Ubuntu from Windows Terminal) and continue with the [Quickstart](quickstart.md) to install NemoClaw and launch your first sandbox. +If you used the bootstrap script, follow the installer command it printed inside Ubuntu. +If you prepared Windows manually, open a WSL terminal (type `wsl` in PowerShell, or open Ubuntu from Windows Terminal) and continue with the [Quickstart](quickstart.md) to install NemoClaw and launch your first sandbox. All NemoClaw commands run inside WSL, not in PowerShell. From e985edf7211f7f2523b8b4c1167f4e4ff2ddb2ed Mon Sep 17 00:00:00 2001 From: Aaron Erickson Date: Tue, 19 May 2026 12:55:03 -0700 Subject: [PATCH 2/2] docs: mirror Windows bootstrap guidance in Fern page --- docs/get-started/windows-preparation.mdx | 33 +++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/get-started/windows-preparation.mdx b/docs/get-started/windows-preparation.mdx index c7118d28086..bc596f3a4b3 100644 --- a/docs/get-started/windows-preparation.mdx +++ b/docs/get-started/windows-preparation.mdx @@ -24,6 +24,36 @@ Verify the following before you begin: - Windows 10 (build 19041 or later) or Windows 11. - Hardware requirements are the same as the [Quickstart](/get-started/quickstart). +## Option: Use the Bootstrap Script + +Open Windows PowerShell on the Windows host and run the bootstrap script: + +```console +$ Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/NVIDIA/NemoClaw/main/scripts/bootstrap-windows.ps1' -OutFile "$env:TEMP\bootstrap-windows.ps1"; powershell.exe -ExecutionPolicy Bypass -File "$env:TEMP\bootstrap-windows.ps1" +``` + +The command downloads the script to a temporary file before running it. +`-ExecutionPolicy Bypass` applies only to that PowerShell process and avoids local policy blocking the downloaded script. +Run it from Windows, not from inside WSL. +The script requests Administrator privileges when needed, enables the required WSL 2 Windows features, installs or opens Ubuntu, and installs and starts Docker Desktop. +If Ubuntu is already registered, the script confirms it uses WSL 2, converts it from WSL 1 when needed, and verifies Docker is reachable from WSL. +If Windows requires a reboot after enabling WSL features, the script prompts for the reboot and registers a one-time continuation for the next sign-in. +If Docker Desktop shows first-run prompts, complete them and return to the PowerShell window. + +For advanced options, download the script first and run `Get-Help "$env:TEMP\bootstrap-windows.ps1" -Detailed`. +Useful parameters include `-DistroName`, `-InstallerUrl`, `-InstallerArgs`, and `-InstallDockerDesktop`. + +The bootstrap script does not install NemoClaw itself. +When Windows preparation is complete, it opens Ubuntu and prints the standard installer command to run inside Ubuntu: + +```console +$ curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash +``` + +If the bootstrap script reports that Docker is not reachable from Ubuntu, open Docker Desktop Settings and confirm that WSL integration is enabled for Ubuntu (Settings > Resources > WSL integration), then rerun the script. + +The manual steps below describe the same Windows preparation pieces and are useful when you need to verify or repair WSL, Ubuntu, or Docker Desktop by hand. + ## Enable WSL 2 Open an elevated PowerShell (Run as Administrator): @@ -102,7 +132,8 @@ Use one instance, or move one of them to a different port before running `nemocl ## Next Step Your Windows environment is ready. -Open a WSL terminal (type `wsl` in PowerShell, or open Ubuntu from Windows Terminal) and continue with the [Quickstart](/get-started/quickstart) to install NemoClaw and launch your first sandbox. +If you used the bootstrap script, follow the installer command it printed inside Ubuntu. +If you prepared Windows manually, open a WSL terminal (type `wsl` in PowerShell, or open Ubuntu from Windows Terminal) and continue with the [Quickstart](/get-started/quickstart) to install NemoClaw and launch your first sandbox. All NemoClaw commands run inside WSL, not in PowerShell.