Contact
Open source · Developer Productivity

Codebase Onboarding Map

Create a short onboarding map from entry points, scripts and domain modules.

v1.0.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Create a concise, navigable onboarding document from a local repository. The tool indexes package entry points, script names, domain directories under src/, and exact or directory ownership declarations in CODEOWNERS. It is read-only and offline. No dependencies; Node.js 22 or later.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+.

Run the checked-in example

node bin/codebase-onboarding-map.mjs --root examples/ready
node bin/codebase-onboarding-map.mjs --root examples/broken
node bin/codebase-onboarding-map.mjs --root examples/ready --max-runtime-ms 5000
npm run check

Read the result

The first example exits 0 and includes a Markdown document in the JSON report's document field. The second exits 1 because its declared entry point has no file. The document links point to files relative to --root; no output file is written. See rules and limits for the input model, unsupported cases and exit codes.