Skip to content

Latest commit

 

History

10 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Codebase Onboarding Map

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.

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

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.

About

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

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages