trialrun
v1.0.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
trialrun
Runs your README's setup instructions in a clean environment and reports what breaks.
trialrun parses your README (or any doc), extracts every shell command and setup step, executes them in isolation, and surfaces what fails — missing env vars, undocumented system dependencies, broken commands. Then it offers to patch your docs with what it found.
Status
🚧 Under active development. Coming soon.
Planned Usage
npx trialrun
npx trialrun --file CONTRIBUTING.md
npx trialrun --patchPart of the @nebulord suite
gitlore— git history archaeologysickbay— zero-config project health diagnosticsdarkstar— environment sentinelbootdrift— startup time regression trackerbundlespy— bundle size CI tracker
License
MIT
