SetupProof

SetupProof tests marked README quickstarts from a clean workspace before contributors hit them.

The main project is setupproof/setupproof.

go install github.com/setupproof/setupproof/cmd/[email protected]
setupproof review README.md
setupproof --require-blocks --no-color --no-glyphs README.md

Use the GitHub Action with a pinned Action tag and CLI version:

- uses: setupproof/[email protected]
  with:
    cli-version: v0.1.3
    require-blocks: "true"
    files: README.md

SetupProof is intentionally narrow: it verifies explicitly marked shell blocks, reports what passed or failed, sends no telemetry, and does not execute unmarked Markdown examples.

Useful entry points:

• Install guide
• GitHub Action usage
• Architecture notes
• Troubleshooting