docs(rigs): try a user-writable npm prefix before a project-local install (#2611)

The rigs skill's Install step offered only npm install -g @openrig/cli. When npm's global prefix isn't writable (often a system Node with prefix /usr), an installing agent improvised a project-local install, and Codex seats then reported rig: command not found. The step now has the agent first point npm's prefix at a folder the person owns whose bin is on their login PATH (for example npm config set prefix ~/.local when ~/.local/bin is on it), saying first that this changes their npm settings and, if needed, their shell profile; use the Node of a version manager such as nvm instead, since nvm refuses an npm prefix setting; and install inside the project only if neither is possible. It links getting-started's "Before you start" for setting and checking the login PATH. Both copies, skills/rigs/SKILL.md and packages/daemon/assets/skills/rigs/SKILL.md, stay identical. Text only; no code, command or gate. Limits: it makes the project-local fallback rarer but doesn't fix why managed Codex seats lose OpenRig's command folder after one (separate work); not run with a live agent install.
This commit is contained in:
Mike Schwarz authored and GitHub committed 2026-11-06 09:38:15 -08:00
1 parent c97cd5c964
commit 829ddfccc7
2 files changed
+20 -6

No files matched your search

+10 -3
View File
@@ -53,9 +53,16 @@ person needs in their project or home folder and name that path.
network access, such as Codex's default one. Re-run that one command with network access before you tell the person
to sign in again or fix anything.
- **Install:** `npm install -g @openrig/cli`, then `rig setup --providers codex` (or `claude`, or `both`: the harness
the person uses). Setup checks Node, tmux and the logins. It installs tmux (with Homebrew, when present) or the chosen
harness (with npm) if either is missing, installs Herdr for the OpenRig view unless they decline it (`--no-herdr`),
and adds an OpenRig block to `~/.tmux.conf`, so say all of that first. It doesn't start the daemon. Then `rig doctor`.
the person uses). If the global install fails because npm's global prefix isn't writable (often a system Node with
prefix `/usr`), first point npm's prefix at a folder the person owns whose `bin` is on their login PATH, for example
`npm config set prefix ~/.local` when `~/.local/bin` is on it; say first that this changes their npm settings, and
their shell profile if `~/.local/bin` isn't on the login PATH. If they use a Node version manager such as nvm,
install with its Node instead; nvm refuses an npm `prefix` setting. Install inside the project only if neither is
possible: Codex seats can then report `rig: command not found`. Setting and checking the login PATH: "Before you
start" in https://github.com/mvschwarz/openrig/blob/main/docs/reference/getting-started.md#before-you-start. Setup
checks Node, tmux and the logins. It installs tmux (with Homebrew, when present) or the chosen harness (with npm) if
either is missing, installs Herdr for the OpenRig view unless they decline it (`--no-herdr`), and adds an OpenRig
block to `~/.tmux.conf`, so say all of that first. It doesn't start the daemon. Then `rig doctor`.
- **Then go on to step 2:** say it's installed and ask what they want worked on, and in which repository. A plain
"install OpenRig" includes this. Stop here only if they say not to start a team.
- **If something fails:** `rig context get help` is the help guide for the installed version. If `rig` itself won't
+10 -3
View File
@@ -53,9 +53,16 @@ person needs in their project or home folder and name that path.
network access, such as Codex's default one. Re-run that one command with network access before you tell the person
to sign in again or fix anything.
- **Install:** `npm install -g @openrig/cli`, then `rig setup --providers codex` (or `claude`, or `both`: the harness
the person uses). Setup checks Node, tmux and the logins. It installs tmux (with Homebrew, when present) or the chosen
harness (with npm) if either is missing, installs Herdr for the OpenRig view unless they decline it (`--no-herdr`),
and adds an OpenRig block to `~/.tmux.conf`, so say all of that first. It doesn't start the daemon. Then `rig doctor`.
the person uses). If the global install fails because npm's global prefix isn't writable (often a system Node with
prefix `/usr`), first point npm's prefix at a folder the person owns whose `bin` is on their login PATH, for example
`npm config set prefix ~/.local` when `~/.local/bin` is on it; say first that this changes their npm settings, and
their shell profile if `~/.local/bin` isn't on the login PATH. If they use a Node version manager such as nvm,
install with its Node instead; nvm refuses an npm `prefix` setting. Install inside the project only if neither is
possible: Codex seats can then report `rig: command not found`. Setting and checking the login PATH: "Before you
start" in https://github.com/mvschwarz/openrig/blob/main/docs/reference/getting-started.md#before-you-start. Setup
checks Node, tmux and the logins. It installs tmux (with Homebrew, when present) or the chosen harness (with npm) if
either is missing, installs Herdr for the OpenRig view unless they decline it (`--no-herdr`), and adds an OpenRig
block to `~/.tmux.conf`, so say all of that first. It doesn't start the daemon. Then `rig doctor`.
- **Then go on to step 2:** say it's installed and ask what they want worked on, and in which repository. A plain
"install OpenRig" includes this. Stop here only if they say not to start a team.
- **If something fails:** `rig context get help` is the help guide for the installed version. If `rig` itself won't