README quickstart verification

SetupProof

Run the setup command people copy from the README before a new contributor has to debug it.

Terminal demo showing SetupProof reviewing and running a marked README quickstart
Review first, then run the marked block from a copied workspace.

What it catches

A broken README should fail in CI.

SetupProof runs the shell block maintainers explicitly mark, then reports the README location that needs attention.

<!-- setupproof id=quickstart -->
```sh
npm ci
npm test
```
[failed] README.md#quickstart file=README.md:18 runner=local timeout=120s result=failed exit=1

Fix the setup path once, in the same place contributors read it.

Where it helps

Catch the boring break before a contributor does.

Setup docs usually fail because something small moved and nobody reran the public path from a clean checkout.

Maintainer path

Mark, review, run.

Keep prose examples inert by default and make only the real setup path executable.

  1. 01
    Mark the trusted block.

    Add a setupproof marker above the README command that must stay runnable.

  2. 02
    Review before executing.

    Inspect the runner, timeout, shell, environment, and source command.

  3. 03
    Run from a clean copy.

    Use the CLI locally or pin the GitHub Action in pull request checks.

Ship setup docs that still work.

Apache-2.0. No telemetry. Built for maintainers who own the README.

View v0.1.0