docs: a standard-user Mac Node.js route on the people page; no sandbox-only paths (#1579)

Two fixes from first-user runs.

- **Node.js on a standard-user Mac:** the quickstart's "What you need" now gives the nvm route with its commands (`touch ~/.zshrc`, nvm v0.40.8's install line, a new terminal, then `nvm install 22`), with no administrator password for nvm itself, and says to run `xcode-select --install` if nvm's installer asks for Apple's command line tools. The README and getting-started name the same command.
- **Shell blocks that paste cleanly:** a trailing `# …` note in a shell block becomes arguments to the command in a Mac's default zsh, so those notes in the quickstart and README now sit in the sentence before their block.
- **No sandbox-only paths for the person:** the rigs skill (both copies) says that a file or command given to the person for their own terminal uses a path that exists on their side; a file a sandboxed agent writes under `/tmp` may not.
This commit is contained in:
Mike Schwarz authored and GitHub committed 2026-10-20 00:36:46 -07:00
1 parent e57325476c
commit 755c66f96a
5 files changed
+41 -15

No files matched your search

+4 -3
View File
@@ -42,7 +42,7 @@ Already have OpenRig? Use the tag that matches `rig --version`, or upgrade first
Prefer to type the commands yourself? [Install it yourself ↓](#install-it-yourself)
Requires Node.js 22 or 24 and tmux, on macOS or Linux, and one working Claude Code or Codex account: one is enough, since the kernel operator adapts the shipped `starter` team to whichever you have. On Linux, the distribution's own Node.js can be older (Ubuntu 24.04's is 18); install a 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 ([compatibility history](docs/releases/v0.5.15.md#known-compatibility-limitation)). On a Mac where you aren't an administrator, or where Homebrew belongs to another account (its `brew install` is refused), install Node.js in your own home folder with [nvm](https://github.com/nvm-sh/nvm): run `touch ~/.zshrc` (a new Mac account has none, and nvm's installer only adds itself to a profile file that already exists), then the install command on nvm's page, open a new terminal, and run `nvm install 22`. That needs no administrator password, and `npm install -g` then installs into your nvm folder. On Windows, use WSL2, the Windows route OpenRig supports; native Windows isn't supported. OpenRig's automated tests don't run on WSL2 yet; see [one user's working setup](docs/reference/getting-started.md#wsl2-a-reported-working-setup).
Requires Node.js 22 or 24 and tmux, on macOS or Linux, and one working Claude Code or Codex account: one is enough, since the kernel operator adapts the shipped `starter` team to whichever you have. On Linux, the distribution's own Node.js can be older (Ubuntu 24.04's is 18); install a 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 ([compatibility history](docs/releases/v0.5.15.md#known-compatibility-limitation)). On a Mac where you aren't an administrator, or where Homebrew belongs to another account (its `brew install` is refused), install Node.js in your own home folder with [nvm](https://github.com/nvm-sh/nvm): run `touch ~/.zshrc` (a new Mac account has none, and nvm's installer only adds itself to a profile file that already exists), then nvm's install command, for nvm v0.40.8 `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.8/install.sh | bash` ([nvm's page](https://github.com/nvm-sh/nvm#install--update-script) has the newest), open a new terminal, and run `nvm install 22`. nvm itself needs no administrator password, and `npm install -g` then installs into your nvm folder. If nvm's installer says you need Apple's command line tools, run `xcode-select --install`, then its install command again. On Windows, use WSL2, the Windows route OpenRig supports; native Windows isn't supported. OpenRig's automated tests don't run on WSL2 yet; see [one user's working setup](docs/reference/getting-started.md#wsl2-a-reported-working-setup).
> **What OpenRig changes on your machine**
> - **Install:** `@openrig/cli` goes in globally with npm.
@@ -106,10 +106,11 @@ to an unused provider.
### Your agent opens OpenRig for you
After installing, your agent opens the OpenRig TUI and the operator for you. To get back to them later, ask your
agent for OpenRig or your agents in any words. After checking the selected login, it runs:
agent for OpenRig or your agents in any words. After checking the selected login, it starts the daemon if it's stopped
and opens the view:
```sh
rig daemon start # if stopped
rig daemon start
rig terminal open saved:kernel --window
```
+10 -6
View File
@@ -72,12 +72,16 @@ you aren't an administrator, or where Homebrew belongs to another account (its
`brew install` is refused), install Node.js in your own home folder with
[nvm](https://github.com/nvm-sh/nvm): run `touch ~/.zshrc` (a new Mac account
has none, and nvm's installer only adds itself to a profile file that already
exists), then the install command on nvm's page, open a new terminal, and run
`nvm install 22`. That needs no administrator password, and `npm install -g`
then installs into your nvm folder. Native
Windows isn't supported. On Windows, use WSL2: it's the Windows route OpenRig
supports, though OpenRig's automated tests don't run on it yet. One user's
[working setup](#wsl2-a-reported-working-setup) is below. Node 20 and
exists), then nvm's install command, for nvm v0.40.8
`curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.8/install.sh | bash`
([nvm's page](https://github.com/nvm-sh/nvm#install--update-script) has the
newest), open a new terminal, and run `nvm install 22`. nvm itself needs no
administrator password, and `npm install -g` then installs into your nvm folder.
If nvm's installer says you need Apple's command line tools, run
`xcode-select --install`, then its install command again. Native Windows isn't
supported. On Windows, use WSL2: it's the Windows route
OpenRig supports, though OpenRig's automated tests don't run on it yet. One
user's [working setup](#wsl2-a-reported-working-setup) is below. Node 20 and
odd-numbered releases (23, 25 and so on) are not supported; Node 26 and later
even-numbered releases are untested.
+19 -6
View File
@@ -30,6 +30,19 @@ Ask your coding agent to help use the toolchain already on your machine. On a Ma
may belong to another user; do not change its ownership to complete this setup. After correcting PATH or installing
Node, open a new terminal and check `node --version` and `npx --version` before continuing.
On a Mac where you aren't an administrator, or where another account owns Homebrew, install Node.js in your own home
folder with [nvm](https://github.com/nvm-sh/nvm); nvm itself needs no administrator password. A new Mac account has no
`~/.zshrc`, and nvm's installer only adds itself to a profile file that already exists, so create one first:
```sh
touch ~/.zshrc
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.8/install.sh | bash
```
Then open a new terminal and run `nvm install 22`. If nvm's installer says you need Apple's command line tools, run
`xcode-select --install`, then its install command again. That's nvm v0.40.8's install command; [nvm's
page](https://github.com/nvm-sh/nvm#install--update-script) has the newest.
## The quick way: let your coding agent do it
In your project folder, add OpenRig's `rigs` skill to the agent you use:
@@ -67,10 +80,10 @@ Node.js and SQLite check was skipped.
### 2. Set up the tools around it
```sh
rig setup --providers claude # or codex, or both
rig setup --providers claude
```
Add `--dry-run` first to see the plan without changing anything. Setup does four things:
Use `codex` or `both` in place of `claude` to match the coding agents you use. Add `--dry-run` first to see the plan without changing anything. Setup does four things:
- it checks Node.js, tmux and your sign-in;
- it installs a missing tmux (with Homebrew on macOS, if you have it) or the coding agent you chose;
- it installs Herdr, a terminal workspace app the OpenRig view can use, unless you add `--no-herdr`;
@@ -132,10 +145,10 @@ Before it starts one, it tells you what starting a team in your folder changes:
`CLAUDE.md`, plus the team's skills. Then it waits for your yes. As shipped, `starter` uses both Claude Code and
Codex. With only one of them, ask the operator to adapt it.
By hand, from your repository:
By hand, from your repository (the first command shows what it would start, and starts nothing):
```sh
rig up starter --cwd . --plan # check what it would start
rig up starter --cwd . --plan
rig up starter --cwd .
rig ps --nodes --rig starter
```
@@ -156,10 +169,10 @@ stops that team. `rig daemon stop` stops the background service and leaves agent
## The one-command install
Instead of steps 1 and 2:
Instead of steps 1 and 2 (the first line shows the plan and changes nothing):
```sh
curl -fsSL https://openrig.dev/install.sh | sh -s -- --dry-run # shows the plan and changes nothing
curl -fsSL https://openrig.dev/install.sh | sh -s -- --dry-run
curl -fsSL https://openrig.dev/install.sh | sh
```
@@ -23,6 +23,10 @@ seats run with an operational default: Codex with `-s danger-full-access -a neve
tools, web fetches and operational commands, including reads under the home folder, allowed without asking. Say so
before you start OpenRig ([the full list](https://github.com/mvschwarz/openrig#what-openrig-changes-on-your-machine)).
When you give the person a file or a command to run in their own terminal, use a path that exists on their side. A
file a sandboxed agent writes under `/tmp` may not exist in the person's terminal (seen with Codex), so put files the
person needs in their project or home folder and name that path.
## 1. Install OpenRig, if it isn't installed
- **Check first:** `rig --version`. If it prints a version, go to step 2.
+4
View File
@@ -23,6 +23,10 @@ seats run with an operational default: Codex with `-s danger-full-access -a neve
tools, web fetches and operational commands, including reads under the home folder, allowed without asking. Say so
before you start OpenRig ([the full list](https://github.com/mvschwarz/openrig#what-openrig-changes-on-your-machine)).
When you give the person a file or a command to run in their own terminal, use a path that exists on their side. A
file a sandboxed agent writes under `/tmp` may not exist in the person's terminal (seen with Codex), so put files the
person needs in their project or home folder and name that path.
## 1. Install OpenRig, if it isn't installed
- **Check first:** `rig --version`. If it prints a version, go to step 2.