readmecheck

Does your README actually run?

Paste a README. We'll show every shell block readmecheck would run in CI — so the install step that 404s on a clean machine fails your build, not your new users.

This previews what would run, in your browser. The command-line version that runs the blocks in CI is not published; ask us if you want it.

Paste a README to see its runnable blocks.

Going past a one-off?

The tool here is free and runs in your browser. deemwar docs — Team is the same engine, set up across your team's CI by deemwar.

Free — this tool

In your browser, nothing to set up

  • Inspect any README here — see what readmecheck would run
  • Directives: skip / network / exit / cwd; console doctests

deemwar docs — Team

Set up by deemwar — talk to us (not self-serve yet)

  • Doc-checks wired across all your org’s repos
  • A GitHub App that comments on the PR when the docs break
  • Org doc-check policies + a status dashboard
  • Set up & maintained for you by deemwar

Set up deemwar docs — Team for your team

Tell us your repos/CI and we'll wire it up — org rulesets, an audit report, and the CI gate. No self-serve checkout; a real engineer sets it up with you.

We receive your email and the page's referrer/UTM tags, never what you put into the tool. Cloudflare Turnstile checks that you are not a bot.

Ask us about readmecheck →