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 pnpm install --frozen-lockfile
corepack pnpm tsgo:patch
corepack pnpm check
corepack pnpm build
corepack pnpm test
corepack pnpm verify

pnpm test requires no external service, network, or database. The E2E matrix uses RouteKit's private TypeScript provider simulator and requires no external simulator checkout or provider credentials. CI always runs the credential-free HTTP/provider matrix; installed coding-agent CLI cases remain optional.

Run focused development workflows

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

Run corepack pnpm dev:link-routekit to install a routekit-dev binary linked to the checkout. The command rebuilds with the repository-pinned pnpm version before every launch; set ROUTEKIT_DEV_SKIP_BUILD=1 only after a successful build when you explicitly want a faster invocation. If the current shell previously resolved the command from another checkout, run rehash in zsh or hash -r in bash after linking.

routekit-dev defaults to an isolated, checkout-scoped local daemon and configuration. To copy the validated router configuration from an already enrolled regular RouteKit remote and use that remote only for provider transport:

routekit-dev init --from-remote orbit

The current checkout still owns local routing and gateway behavior; provider credentials remain on the remote.

Next steps

• Package map
• Operations and scripts
• Testing