Skip to content

Development setup

Requirements: Node.js 24 or later. The package pins npm@11.17.0 as its package manager.

Terminal window
npm install
CommandWhat it does
npm run devStarts the Vite dev server
npm run buildProduction build
npm run testVitest, interactive
npm run test:runVitest, single run
npm run lintBiome lint across src, shared, electron/main, worker, echo, echo-local, cli, extension/chrome, extension/vscode, tests, scripts
npm run formatBiome format, write mode
npm run architecture:checkEnforces runtime dependency directions, cycles, and file-size ratchets
npm run validateThe full gate: static/type/architecture checks, root and workspace tests with coverage, all production builds, Electron runtime-import verification, and size budgets

npm run type-check runs tsc --noEmit against the root tsconfig.json only. That config’s exclude array is:

["node_modules", "dist", "out", "worker", "electron/main", "cli", "extension", "docs-site"]

npm run type-check:all is the command that actually covers them: it runs the base renderer check, the TypeScript-tooling and checked-JavaScript ratchets, five more tsc --noEmit -p <tsconfig> project builds (electron/tsconfig.json, src/features/http/tsconfig.json, worker/tsconfig.json, echo/tsconfig.json, echo-local/tsconfig.json), plus the CLI, Chrome extension, and VS Code workspace type-checks. npm run validate — and CI — use type-check:all, not the plain type-check.