showboat

Create executable markdown demos that record commands and stable outputs.

Updated Mar 22, 2026
One-click install
npx skills add https://github.com/withakay/research --skill showboat-withakay
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: showboat
Source: https://github.com/withakay/research/tree/main/.agents/skills/showboat
Command: npx skills add https://github.com/withakay/research --skill showboat-withakay

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires showboat, and includes scripts (resource) and references (resource) components.

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

Frequently Asked Questions about showboat

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create reproducible executable markdown demos for CLI and API verification?

You can create reproducible executable markdown demos by initializing a Showboat document, adding context notes, executing commands directly within the markdown, and running a verification step to ensure stable output replay.

What is executable markdown proofing and when do I need it for software testing?

Executable markdown proofing generates demonstration documents that verify software workflows by recording commands and stable outputs. It is needed for proving repo behavior in tests, CLI operations, local services, Aspire AppHosts, and HTTP APIs.

Does Showboat work with Aspire AppHosts for integration demos?

Yes, Showboat supports creating Aspire-backed demos by keeping the AppHost lifecycle inside a helper script, allowing you to focus on capturing and verifying stable proof lines from the integration output.

How do I generate and verify a workflow demonstration document step by step?

Initialize the document with a title, add context using notes, execute commands like tests or API calls directly into the file, and run the verify command to check the reproducibility of the recorded workflow outputs.

Do I need uvx to run Showboat commands for workflow verification?

Yes, the quick start process uses uvx to run Showboat commands for initializing markdown files, adding notes, executing bash commands, and verifying the reproducible demonstration documents.

What are the limitations of using executable markdown for reproducibility?

Executable markdown reproducibility relies on stable command outputs; workflows with volatile, time-sensitive, or non-deterministic outputs may fail verification and require careful command structuring to maintain stable proof lines.