diff --git a/README.md b/README.md index 1e359152c..b9d043104 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Not setting this up today? Get the next walkthrough and occasional OpenRig updat ## Install and first run -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 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). Launching a rig writes provider hooks and workspace trust settings. Before running the commands below, read [what OpenRig changes on your machine](#what-openrig-changes-on-your-machine) and back up the relevant files. +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). Launching a rig writes provider hooks and workspace trust settings. Before running the commands below, read [what OpenRig changes on your machine](#what-openrig-changes-on-your-machine) and back up the relevant files. **One command.** This runs OpenRig's install script from the `v0.6.11` release. It checks Node.js and npm, installs the latest published `@openrig/cli` with `npm install -g`, runs the Node.js and SQLite check, then runs `rig setup --dry-run` and `rig setup`. The first line prints that plan and changes nothing: diff --git a/docs/reference/getting-started.md b/docs/reference/getting-started.md index 3f612b279..68da92354 100644 --- a/docs/reference/getting-started.md +++ b/docs/reference/getting-started.md @@ -15,14 +15,20 @@ operator in the OpenRig view. ## Before you start -You need 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 (see the [compatibility -history](../releases/v0.5.15.md#known-compatibility-limitation)). Native +You need 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 (see the [compatibility +history](../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. 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 diff --git a/docs/reference/publishing-a-rig-bundle.md b/docs/reference/publishing-a-rig-bundle.md index cd24296e9..d6d964921 100644 --- a/docs/reference/publishing-a-rig-bundle.md +++ b/docs/reference/publishing-a-rig-bundle.md @@ -116,8 +116,11 @@ an issue there with the same three things. A maintainer then writes the full ent defined in the [bundle formats reference](bundle-formats.md), with the parts only a review can produce, such as the pinned commit and each configuration's package digest. -Rig names are unique on the site. If `registry/.yaml` already exists, openrig-registry's registry check says the name is taken; -choose a distinct one, for example `-`. +Rig names are unique on the site. If `registry/.yaml` already exists, openrig-registry's registry check +still replies that your submission was received, and says the name is taken; choose a distinct one, for example +`-`. A team whose `rig.yaml` name matches a listed team's, such as an unchanged copy of one, +passes the checks with a notice for the maintainer about the shared name. Whether it's listed is the maintainer's +review decision, not the checks'. What happens next: - a maintainer pins your link to an exact commit, runs the same check, and reads everything your bundle gives to an