What happens if I make a mistake while recording a demo?

The skill includes a 'pop' command that allows you to remove the most recent entry from the document so you can fix your code or command and try again immediately.

How does the verification process work?

The verify command re-runs every execution block stored in the Markdown file and compares the new output against the recorded version to detect regressions or environmental changes.

Can I use this for API testing?

Yes, it is highly effective for documenting API behavior by capturing curl commands and responses, especially when piped through jq for readability.

Does this replace unit tests?

No, Showboat is intended for high-level proof-of-work and documentation. Unit tests should still be used for internal logic and implementation details.

What is a Showboat demo?

A Showboat demo is an executable Markdown file that contains both narrative text and captured command output, allowing developers to prove their code works exactly as described.

Showboat Demo Builder

Name: Showboat Demo Builder
Author: betamatt

bybetamatt

•

学习与文档

Generates reproducible Markdown documentation by capturing live command-line output to provide verifiable proof-of-work for features and bug fixes.

Showboat Demo Builder empowers developers to move beyond static tests by creating executable Markdown documentation that captures real-time command output. By wrapping terminal commands and narrative notes into a structured format, this skill allows users to build, verify, and maintain live demos for APIs, CLI tools, and workflows. It ensures that documentation remains accurate and reproducible, providing a robust proof-of-work document that can be shared in pull requests or onboarding guides to demonstrate that code functions as intended in a live environment.

主要功能

01Automated Markdown demo generation from real-time CLI execution

02Narrative note insertion to provide context between command blocks

03Error recovery with 'pop' functionality to remove and retry failed steps

04Support for formatting complex outputs like JSON and CLI help menus

05Integrated verification system to ensure demos remain reproducible and accurate

061 GitHub stars

使用场景

01Creating interactive, verified onboarding tutorials for internal developer tools

02Attaching proof-of-work documents to pull requests to demonstrate feature functionality

03Documenting bug fixes with reproducible steps that prove the resolution in the CLI

主要功能

01Automated Markdown demo generation from real-time CLI execution

02Narrative note insertion to provide context between command blocks

03Error recovery with 'pop' functionality to remove and retry failed steps

04Support for formatting complex outputs like JSON and CLI help menus

05Integrated verification system to ensure demos remain reproducible and accurate

061 GitHub stars

使用场景

01Creating interactive, verified onboarding tutorials for internal developer tools

02Attaching proof-of-work documents to pull requests to demonstrate feature functionality

03Documenting bug fixes with reproducible steps that prove the resolution in the CLI