DOCUMENTATION / VERSIONED CONTRACTS

Playtestr documentation

Playtestr drives trusted interactive terminal applications with authored keyboard input and checks their rendered text. Start with the stable binary, prove one passing and one failing case, then adapt the small spec to your own application.

Stable v0.1.0 is the original MVP. Verified prerelease v0.4.0-rc.3 adds later suites, HTML reports, workspaces and the selected CJK repair. Choose a release or follow the prerelease installation guide .

Learn the workflow#

1. Install v0.1.0 and run a first test .
2. Write a test for your CLI or TUI .
3. Adapt a complete real-application recipe .
4. Add a reviewed text snapshot when a complete screen is useful.
5. Diagnose failures by category, failed step, screen, and diff.
6. Reproduce a CI failure locally from reviewed identities and ordinary rerun commands.
7. Install an exact release in GitHub Actions with independently pinned action and runner versions.
8. Use a repeatable workspace for a stateful local flow.

Use the reference#

• Test specification v1 defines inputs, actions, defaults, and limits.
• Machine report v1 defines structured outcomes and evidence references.
• Test specification v2 and machine report v2 define opt-in workspace execution and its outcomes.
• Offline failure reports explains safe, bounded HTML export and diagnosis.
• CI installation defines exact version selection, verification, fallback, removal, and maintenance.
• Compatibility and evidence records exact supported downloads and terminal limits.

Stable v0.1.0 uses spec/report version 1. Workspace v2 describes the current development runner and is not part of that stable binary. Development plans are proposals until their behavior is implemented and evidenced.