Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,17 @@ technical problem on its own terms and the private tracker links to it.
## Set up the repository

The monorepo recommends Node.js 24 LTS and uses pnpm 11.28.2. Node.js 22 is
also supported from 22.13.0. Docker is required for the local platform stack
and workspace end-to-end tests. For nvm users, the repository's `.nvmrc` selects
the recommended Node.js 24 line with `nvm use`.
also supported from 22.13.0. Node.js 25 and later fall outside that range and
no longer bundle Corepack, so `corepack enable` is not available there; the
command below installs the pinned pnpm on every supported release. Docker is
required for the local platform stack and workspace end-to-end tests. For nvm
users, the repository's `.nvmrc` selects the recommended Node.js 24 line with
`nvm use`.

```bash
git clone https://github.com/theam/facility.git
cd facility
corepack install --global pnpm@11.28.2
npm install --global pnpm@11.28.2
pnpm dev
```

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,17 @@ The project manifest also lets you [choose CPU and memory for new story workspac
## Quick start: run Facility

You need Docker, Node.js 24 LTS, and pnpm 11.28.2. Node.js 22 is also supported
from 22.13.0. Start the application locally, then connect a repository to run
Claude Code or Codex in a story workspace.
from 22.13.0. Node.js 25 and later are outside the supported range and no longer
bundle Corepack; `.nvmrc` selects a supported line. Start the application
locally, then connect a repository to run Claude Code or Codex in a story
workspace.

### 1. Open the local application

```bash
git clone https://github.com/theam/facility.git
cd facility
corepack install --global pnpm@11.28.2
npm install --global pnpm@11.28.2
pnpm dev
```

Expand Down Expand Up @@ -161,7 +163,7 @@ behavior and boundaries can be agreed on.
```bash
git clone https://github.com/theam/facility.git
cd facility
corepack install --global pnpm@11.28.2
npm install --global pnpm@11.28.2
pnpm install --frozen-lockfile
pnpm verify
```
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/docs/reference/reference-fixture.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sample builder and scheduled-security agents. It has no network or credential de
From a clean checkout, run:

```bash
corepack install --global pnpm@11.28.2
npm install --global pnpm@11.28.2
pnpm install --frozen-lockfile
docker build -f runner/Dockerfile -t facility-runner:dev .
FACILITY_E2E_DOCKER=1 \
Expand Down
10 changes: 6 additions & 4 deletions apps/docs/docs/self-host/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@ This guide covers work on the Facility monorepo. If you only want to run the pro
Install Node.js 24 LTS and pnpm 11.28.2 before running the repository:

```bash
corepack install --global pnpm@11.28.2
npm install --global pnpm@11.28.2
```

The root `package.json` also accepts Node.js 22 from 22.13.0. Use the repository `.nvmrc` when
working with nvm. Do not substitute npm or yarn: the lockfile, workspace filters, and verification
scripts assume pnpm.
The root `package.json` also accepts Node.js 22 from 22.13.0. Node.js 25 and later are outside that
range and no longer bundle Corepack; use the repository `.nvmrc` to select a supported line when
working with nvm. npm appears above only to install the pinned pnpm, which works on every supported
release. Do not substitute npm or yarn for pnpm itself: the lockfile, workspace filters, and
verification scripts assume pnpm.

Clone the repository, then run:

Expand Down
7 changes: 4 additions & 3 deletions apps/docs/docs/self-host/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ guide](production.md) before exposing an instance to other users or repositories

Install Docker, Node.js 24, and the repository-pinned pnpm version.

Node.js 22 is also supported from 22.13.0. Docker must be running and the current user must be able
to use it. Local story workspaces require enough disk for repository checkouts, dependencies,
Node.js 22 is also supported from 22.13.0. Node.js 25 and later are outside the supported range and
no longer bundle Corepack; use `.nvmrc` to select a supported line. Docker must be running and the
current user must be able to use it. Local story workspaces require enough disk for repository checkouts, dependencies,
nested Docker images, and persistent volumes.

## Start the local stack

```bash
corepack install --global pnpm@11.28.2
npm install --global pnpm@11.28.2
pnpm install --frozen-lockfile
cp .env.example .env
docker build -f runner/Dockerfile -t facility-runner:dev .
Expand Down
2 changes: 1 addition & 1 deletion scripts/toolchain.test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,6 @@ test("setup documentation installs the package-manager pin", async () => {
]) {
const documentation = await read(path);
assert.match(documentation, /pnpm(?:@| )11\.28\.2/);
assert.match(documentation, /corepack install --global pnpm@11\.28\.2/);
assert.match(documentation, /npm install --global pnpm@11\.28\.2/);
}
});
Loading