What problem does it solve?
This Skill solves the problem of creating reproducible demonstration documents that can be used to prove repo behavior with executable markdown, which is especially useful for tests, CLI, local services, Aspire AppHosts, and HTTP APIs.
Core Features & Use Cases
- Executable Markdown Demos: Generate demonstration documents that prove one workflow by recording the commands and stable outputs needed to replay it.
- Command Patterns: Follow a structured pattern using
uvx showboat to add notes, execute commands, and verify the document's reproducibility.
- Durable Outbox Integration Demos: Support for creating Aspire-backed demos that keep the AppHost lifecycle inside a helper script and focus on stable proof lines in the output.
Quick Start
Initialize a Showboat document for a demo, add context, execute commands, and verify the output:
uvx showboat init demos/<name>.md "<Readable Demo Title>"
uvx showboat note demos/demo.md "This demonstrates the integration path."
uvx showboat exec demos/demo.md bash "uv run pytest -q"
uvx showboat verify demos/demo.md