Showboat

Overview

Use uvx showboat to build Markdown documents that mix short notes, executable commands, and captured output. Reach for it when the deliverable should both explain and prove behavior. This should be used to do live integration tests. You should NOT use showboat to run existing tests.

Workflow

1. Confirm the CLI is available with uvx showboat --help.
2. Pick the document path. Default to demo-{num}-{title}.md in the current workspace unless the user specifies another file. Use the next available integer for {num} and a short kebab-case summary for {title}.
3. Initialize the document with uvx showboat init <file> <title>.
4. Add short context blocks with uvx showboat note <file> ....
5. Record proof steps with uvx showboat exec <file> <lang> <code>.
6. Prefer commands that prove the real behavior, such as tests, generated artifacts, or verification commands.
7. If screenshots matter, add them with uvx showboat image <file> ....
8. If a step was wrong or too noisy, remove it with uvx showboat pop <file>.
9. Finish by running uvx showboat verify <file>.

Stable Proof Requirements