alphacrack/readme2demo
Run a repo's README in a hardened Docker sandbox, replay it in a fresh container, and fail CI when it breaks.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| anthropic-api-key | Anthropic API key (metered billing). One secret drives both the sandboxed agent and the planner/distiller/tutorial passes. Pass a repo secret; prefer a dedicated low-limit key. | yes | — |
| repo-url | https URL of the repo to verify (github.com / gitlab.com). Defaults to the repository running the workflow. URL mode clones the remote default branch HEAD — see the header comment. | no | ${{ github.server_url }}/${{ github.repository }} |
| budget-usd | Abort the run if agent cost exceeds this many USD. | no | 5 |
| skip-video | "true" to skip the VHS demo video render. Saves wall-clock time; the render itself costs no API money. | no | false |
| timeout | Agent wall-clock timeout in seconds. Empty means readme2demo's own default applies. | no | "" |
Outputs
| name | description |
|---|---|
| verified | "true" when the fresh-container replay passed, "false" when the run completed unverified. Empty when the pipeline itself failed. |
| run-dir | Absolute path (on the runner) to the runs/<run-id> directory holding manifest.json and all artifacts. Empty if the run failed before a run directory was created. |