docs: recommend WSL2 for Windows installs

This commit is contained in:
Peter Steinberger
2026-01-07 01:21:36 +01:00
parent 62112d9978
commit 0116184b1c
13 changed files with 123 additions and 31 deletions

View File

@@ -212,6 +212,6 @@ Logs live under `/tmp/clawdbot/` (default: `clawdbot-YYYY-MM-DD.log`).
- macOS menu bar companion: [Clawdbot macOS app](/macos)
- iOS node app: [iOS app](/ios)
- Android node app: [Android app](/android)
- Windows status: [Windows app](/windows)
- Windows status: [Windows (WSL2)](/windows)
- Linux status: [Linux app](/linux)
- Security: [Security](/security)

View File

@@ -28,11 +28,11 @@ Your **workspace** (AGENTS.md, memory files, skills) is separate — configured
### What platforms does Clawdbot run on?
**macOS and Linux** are the primary targets. Anywhere Node.js 22+ runs should work in theory.
**macOS and Linux** are the primary targets. On Windows, use **WSL2** (Ubuntu recommended).
- **macOS** — Fully supported, most tested
- **Linux** — Works great, common for VPS/server deployments
- **Windows** — Should work but largely untested! You're in pioneer territory 🤠
- **Windows (WSL2)** — WSL2 is strongly recommended; native Windows installs are untested and more problematic
Some features are platform-specific:
- **iMessage** — macOS only (uses `imsg` CLI)
@@ -52,6 +52,18 @@ The gateway is just shuffling messages around. A Raspberry Pi 4 can run it. For
clawdbot gateway
```
### How do I install on Windows?
Use **WSL2** (Ubuntu recommended) and follow the Linux flow inside WSL. Quick start:
```powershell
wsl --install
```
Then open Ubuntu and run the normal Getting Started steps.
Full guide: [Windows (WSL2)](/windows)
### How do I install on Linux without Homebrew?
Build CLIs from source! Example for `gogcli`:
@@ -494,9 +506,10 @@ Onboarding attempts to enable lingering; if its still off, run:
sudo loginctl enable-linger $USER
```
**macOS/Windows**
**macOS/WSL2**
Gateway daemons run in the user session by default. Keep the user logged in.
Gateway daemons run in the user session by default. Keep the user logged in
(WSL2 services stop when the WSL VM shuts down).
Headless/system services are not configured out of the box.
### Processes keep restarting after I kill them

View File

@@ -26,6 +26,7 @@ If you want the deeper reference pages, jump to: [Wizard](/wizard), [Setup](/set
- Git
macOS: if you plan to build the apps, install Xcode / CLT. For the CLI + gateway only, Node is enough.
Windows: use **WSL2** (Ubuntu recommended). WSL2 is strongly recommended; native Windows is untested and more problematic. Install WSL2 first, then run the Linux steps inside WSL. See [Windows (WSL2)](/windows).
## 1) Check out from source
@@ -63,7 +64,7 @@ What youll choose:
- **Local vs Remote** gateway
- **Auth**: Anthropic OAuth or OpenAI OAuth (recommended), API key (optional), or skip for now
- **Providers**: WhatsApp QR login, bot tokens, etc.
- **Daemon**: optional background install (launchd/systemd/Task Scheduler)
- **Daemon**: optional background install (launchd/systemd; WSL2 uses systemd)
- **Runtime**: Node (recommended; required for WhatsApp) or Bun (faster, but incompatible with WhatsApp)
Wizard doc: [Wizard](/wizard)

View File

@@ -131,7 +131,7 @@ Use these hubs to discover every page, including deep dives and reference docs t
- [macOS Peekaboo plan](https://docs.clawd.bot/platforms/mac/peekaboo)
- [iOS node](https://docs.clawd.bot/platforms/ios)
- [Android node](https://docs.clawd.bot/platforms/android)
- [Windows app](https://docs.clawd.bot/platforms/windows)
- [Windows (WSL2)](https://docs.clawd.bot/platforms/windows)
- [Linux app](https://docs.clawd.bot/platforms/linux)
- [Web surfaces](https://docs.clawd.bot/web)

View File

@@ -187,3 +187,11 @@ chmod 600 ~/.clawdbot/credentials/oauth.json
| `accessToken` | `access` |
| `refreshToken` | `refresh` |
| `expiresAt` | `expires` |
## Workspace backup (recommended)
We suggest creating a **private GitHub repository** to back up the agent
workspace. The agent is really good at keeping a git repo in shape, and GitHub
is the perfect place for it. Keep it **private**.
Setup steps: https://docs.clawd.bot/concepts/agent-workspace

View File

@@ -7,7 +7,8 @@ read_when:
# Onboarding Wizard (CLI)
The onboarding wizard is the **recommended** way to set up Clawdbot on any OS.
The onboarding wizard is the **recommended** way to set up Clawdbot on macOS,
Linux, or Windows (via WSL2; strongly recommended).
It configures a local Gateway or a remote Gateway connection, plus providers, skills,
and workspace defaults in one guided flow.
@@ -30,7 +31,7 @@ clawdbot configure
- Workspace location + bootstrap files
- Gateway settings (port/bind/auth/tailscale)
- Providers (WhatsApp, Telegram, Discord, Signal)
- Daemon install (LaunchAgent / systemd user unit / Scheduled Task)
- Daemon install (LaunchAgent / systemd user unit)
- Health check
- Skills (recommended)
@@ -77,11 +78,9 @@ It does **not** install or change anything on the remote host.
6) **Daemon install**
- macOS: LaunchAgent
- Requires a logged-in user session; for headless, use a custom LaunchDaemon (not shipped).
- Linux: systemd user unit
- Linux (and Windows via WSL2): systemd user unit
- Wizard attempts to enable lingering via `loginctl enable-linger <user>` so the Gateway stays up after logout.
- May prompt for sudo (writes `/var/lib/systemd/linger`); it tries without sudo first.
- Windows: Scheduled Task
- Runs on user logon; headless/system services are not configured by default.
- **Runtime selection:** Node (recommended; required for WhatsApp) or Bun (faster, but incompatible with WhatsApp).
7) **Health check**
@@ -144,7 +143,7 @@ The wizard can install `signal-cli` from GitHub releases:
Notes:
- JVM builds require **Java 21**.
- Native builds are used when available.
- Windows autoinstall is not supported yet (manual install required).
- Windows uses WSL2; signal-cli install follows the Linux flow inside WSL.
## What the wizard writes