mirror of
https://github.com/mvschwarz/openrig.git
synced 2026-11-07 05:56:21 -10:00
docs: add a user's reported WSL2 setup to the getting-started guide (#960)
The getting-started guide records WSL2 as one user's reported working setup, not a supported platform.
This commit is contained in:
1 parent
134f128eb6
commit
a5f039590d
3 files changed
+30
-3
No files matched your search
@@ -420,7 +420,8 @@ seat, plugin, and release lifecycle actions remain agent-owned.
|
||||
longer supported. Node 26 and other versions are untested. On a Mac with Apple
|
||||
silicon, use Node.js 22: see the [compatibility history](docs/releases/v0.5.15.md#known-compatibility-limitation).
|
||||
- tmux
|
||||
- macOS or Linux. Native Windows is not supported yet, and WSL2 has not been tested
|
||||
- macOS or Linux. Native Windows is not supported yet. WSL2 isn't supported either;
|
||||
one user's working setup is in the [getting-started guide](docs/reference/getting-started.md#wsl2-a-reported-working-setup)
|
||||
|
||||
Optional:
|
||||
- herdr or cmux for terminal workspaces showing the agents together
|
||||
|
||||
@@ -22,7 +22,8 @@ supported version with [nvm](https://github.com/nvm-sh/nvm) (`nvm install 22`)
|
||||
or NodeSource. On a Mac with Apple
|
||||
silicon, use Node.js 22 (see the [compatibility
|
||||
history](../releases/v0.5.15.md#known-compatibility-limitation)). Native
|
||||
Windows is not supported yet, and WSL2 has not been tested. Node 20 and
|
||||
Windows is not supported yet. WSL2 isn't a supported platform either, though one
|
||||
user has [reported a working setup](#wsl2-a-reported-working-setup). Node 20 and
|
||||
odd-numbered releases (23, 25 and so on) are not supported; Node 26 and later
|
||||
even-numbered releases are untested.
|
||||
|
||||
@@ -62,6 +63,30 @@ before-install view explain that access before you choose it.
|
||||
> "kernel ready" does not mean every kernel agent is healthy; a workspace root
|
||||
> being *live* does not mean it is the *right* one for your project.
|
||||
|
||||
## WSL2: a reported working setup
|
||||
|
||||
This is one user's report, not a supported platform.
|
||||
[dajiaohuang](https://github.com/dajiaohuang)
|
||||
[ran OpenRig 0.6.6 under WSL2](https://github.com/mvschwarz/openrig/issues/88#issuecomment-6043925546)
|
||||
on Ubuntu 24.04, with Node.js 24.14.1, tmux 3.4, Codex CLI 0.161.0 and Pi
|
||||
(`@earendil-works/pi-coding-agent`) 1.0.4, headless, as the distribution's root
|
||||
user.
|
||||
|
||||
- **What worked**, with one Codex seat and one Pi seat: `rig doctor`, starting
|
||||
the daemon (`rig daemon start --no-kernel`), launching both seats, replies to
|
||||
`rig send` and `rig capture`, and stopping with `rig down --snapshot`
|
||||
followed by a warm restore with `rig up --existing`.
|
||||
- **What mattered:**
|
||||
- the install and the OpenRig instance on the Linux filesystem;
|
||||
- Linux-native Node.js and harnesses, not the Windows `npm` or `pi` that WSL
|
||||
inherits;
|
||||
- Pi credentials in the managed seat's agent directory, because a global Pi
|
||||
login isn't shared with managed seats;
|
||||
- the current `@earendil-works/pi-coding-agent` package in its own npm prefix,
|
||||
not the deprecated `@mariozechner` one.
|
||||
- **Not tested:** the kernel and operator, herdr, reboot, suspend and resume,
|
||||
cross-host operation and long-running work.
|
||||
|
||||
## Install and sign in
|
||||
|
||||
**One command, when the person wants the full setup.** It needs Node.js 22 or 24 with npm already installed. First
|
||||
|
||||
@@ -47,7 +47,8 @@ rather than treating a newer command as installed.
|
||||
|
||||
### Installation or platform problems
|
||||
|
||||
Supported platforms are macOS and Linux. Native Windows is not supported yet, and WSL2 has not been tested. OpenRig needs
|
||||
Supported platforms are macOS and Linux. Native Windows is not supported yet. WSL2 isn't supported either; one user's
|
||||
[reported working setup](getting-started.md#wsl2-a-reported-working-setup) lists what mattered. OpenRig needs
|
||||
Node.js 22 or 24 and tmux. A Linux distribution's own Node.js can be older; check `node --version`. With npm 11 or
|
||||
later, an `npm warn install-scripts` line for `@openrig/cli` means only the postinstall Node.js and SQLite check was
|
||||
skipped; `node "$(npm root -g)/@openrig/cli/scripts/check-abi.mjs"` runs it. A WSL error needs its actual versions,
|
||||
|
||||
Reference in new issue
Block a user