vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-03-20 14:30:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify native Windows support alongside WSL2 across getting-started, windows, and onboarding-overview

Browse Source
This commit is contained in:
Vincent Koc
2026-03-19 11:28:53 -07:00
parent cb78f38da9
commit 22c1bda2a0
3 changed files with 18 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/platforms/windows.md
View File

@@ -1,22 +1,22 @@
---
summary: "Windows (WSL2) support + companion app status"
summary: "Windows support: native and WSL2 install paths, daemon, and current caveats"
read_when:
- Installing OpenClaw on Windows
- Choosing between native Windows and WSL2
- Looking for Windows companion app status
title: "Windows (WSL2)"
title: "Windows"
---
# Windows (WSL2)
# Windows
OpenClaw on Windows is recommended **via WSL2** (Ubuntu recommended). The
CLI + Gateway run inside Linux, which keeps the runtime consistent and makes
tooling far more compatible (Node/Bun/pnpm, Linux binaries, skills). Native
Windows might be trickier. WSL2 gives you the full Linux experience — one command
to install: `wsl --install`.
OpenClaw supports both **native Windows** and **WSL2**. WSL2 is the more
stable path and recommended for the full experience — the CLI, Gateway, and
tooling run inside Linux with full compatibility. Native Windows works for
core CLI and Gateway use, with some caveats noted below.
Native Windows companion apps are planned.
## Install (WSL2)
## WSL2 (recommended)
- [Getting Started](/start/getting-started) (use inside WSL)
- [Install & updates](/install/updating)

3
docs/start/getting-started.md
View File

@@ -19,7 +19,8 @@ and a working chat session.
<Tip>
Check your Node version with `node --version`.
Windows users: WSL2 is strongly recommended. See [Windows](/platforms/windows).
**Windows users:** both native Windows and WSL2 are supported. WSL2 is more
stable and recommended for the full experience. See [Windows](/platforms/windows).
Need to install Node? See [Node setup](/install/node).
</Tip>

14
docs/start/onboarding-overview.md
View File

@@ -14,13 +14,13 @@ optional channels — they just differ in how you interact with the setup.
## Which path should I use?
| | CLI onboarding | macOS app onboarding |
| -------------- | ------------------------------- | ------------------------- |
| **Platforms** | macOS, Linux, Windows (WSL2) | macOS only |
| **Interface** | Terminal wizard | Guided UI in the app |
| **Best for** | Servers, headless, full control | Desktop Mac, visual setup |
| **Automation** | `--non-interactive` for scripts | Manual only |
| **Command** | `openclaw onboard` | Launch the app |
| | CLI onboarding | macOS app onboarding |
| -------------- | -------------------------------------- | ------------------------- |
| **Platforms** | macOS, Linux, Windows (native or WSL2) | macOS only |
| **Interface** | Terminal wizard | Guided UI in the app |
| **Best for** | Servers, headless, full control | Desktop Mac, visual setup |
| **Automation** | `--non-interactive` for scripts | Manual only |
| **Command** | `openclaw onboard` | Launch the app |
Most users should start with **CLI onboarding** — it works everywhere and gives
you the most control.