readmecheck
v1.1.0
Published
Audits your README by actually executing it. Finds missing env vars, undocumented dependencies, and broken setup steps — then offers to fix them.
Maintainers
Readme
readmecheck
Audits your README by actually executing it.
readmecheck parses your README, extracts every shell command and setup step, runs them in a clean environment, and reports what breaks. Missing env vars, undocumented system dependencies, broken commands — all surfaced automatically. Then it offers to patch your README with what it found.
Status
🚧 Under active development. Name reserved. Coming soon.
Planned Usage
npx readmecheck
npx readmecheck --fix
npx readmecheck --ciPart of the @nebulord suite
sickbay— project health diagnosticsgitlore— git history archaeologydarkstar— environment sentinelbootdrift— startup time regression trackerbundlespy— bundle size CI tracker
License
MIT
