Reading the repo
Opening the box…
Reading the repo
Opening the box…
Assembly instructions
Fresh setup, read just now
Will it work on macOS?
Heads-upIt also needs 10 settings in .env.
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/iant89/ClawRouter.git cd ClawRouter
Node.js LTS (no version pinned), Bun, jq
# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm) nvm install --lts curl -fsSL https://bun.sh/install | bash brew install jq
cp .env.example .env
bun install
bun run dev
bun run test
bun install # ENTERPRISE-UI comes from vendor/enterprise-ui-react.tgz (committed)
bun run dev # http://127.0.0.1:8080, with hot reload
On first start there are no users. The server writes a one-time setup token
to data/setup-token (mode 0600) and logs that path. Open the console, which
redirects to /setup, paste the token, and create the first administrator.
The token file is deleted and /setup closes for good once setup succeeds.
Development also generates data/secret.key, which encrypts provider API keys.
Keep it with the database: without it, stored keys cannot be decrypted.
bun run dev starts one process that serves:
| Path | What |
|---|---|
| /api/* | Administration API (JSON, session cookie). See authentication |
| /api/ws | The console's live channel (WebSocket, session cookie, same origin). See real-time |
| /v1/* | External AI gateway API, OpenAI-compatible, API keys only. See gateway |
| everything else | The console (React + ENTERPRISE-UI), bundled on the fly by Bun with HMR |
curl -s http://127.0.0.1:8080/api/health | jq
No reports for macOS yet.
GitManual AI Agent reads the 5 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.