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+; inspect the source before using it on your own files.
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 checkRead 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.
Where this check stops
This local walkthrough does not establish the state of a live production system or replace the limits documented in the repository.
Before adapting the command to your own workflow, review the accepted inputs, exit codes and safety boundaries in the README.
Compiled with AI assistance from checked-in public documentation and example scripts. Run the example and review the repository's current documentation before relying on its result.