Develop RouteKit from source

Use this guide for repository development. Product users should install the published CLI through the installation guide.

Prerequisites

• Node.js 22.22.0 or newer
• Corepack
• Git

The repository pins pnpm through package.json.

Install dependencies and verify the repository

corepack enable
pnpm install --frozen-lockfile
pnpm check
pnpm build
pnpm test
pnpm verify

pnpm test requires no external service, network, or database. The optional E2E matrix skips provider-simulator suites when routekit-sim is unavailable.

Run focused development workflows

pnpm build:cli
pnpm test:root
pnpm test:e2e:matrix
pnpm package:lint
pnpm package:types
pnpm docs:dev
pnpm docs:build

Run pnpm dev:link-routekit to install a routekit-dev binary linked to the checkout.

Next steps

• Package map
• Operations and scripts
• Testing