Getting started

Prerequisites

Use Node.js 22.12.0 or newer and pnpm 10.0.0 or newer. Run commands at the repository root.

For live coding, you also need Cloudflare Workers, Workers AI, Durable Objects and Containers access, a compatible container engine, and a public GitHub repository. Read Readiness before provisioning anything.

Install and verify

pnpm install
pnpm typecheck
pnpm lint
pnpm test
pnpm docs:check
pnpm build

The combined build writes the dashboard to public/ and docs to public/docs/. It does not deploy or publish a PR.

Preview documentation

pnpm docs:preview

Open http://localhost:4321/docs/. Production builds include Pagefind search; the docs development server does not.

Prepare the coding application

Copy .dev.vars.example to the ignored .dev.vars file. Set the values described in Configuration. Public diff-only runs need no GitHub token.

The Vite command, pnpm dev, is UI-only, with no Worker API or WebSocket proxy. Use Local development for Worker startup. A static page is not evidence that the cloud coding integration works.

After resolving the readiness blockers, submit a small task against a public test repository you own, review the exact tool input, approve or reject it, and inspect the final transcript and diff. Keep publishing off initially. Run the target repository’s checks before adopting any generated changes.