showboat

Embed live command outputs into Markdown documents using the showboat CLI.

Updated Jan 20, 2026
One-click install
npx skills add https://github.com/Cmwilson05/budget-manager --skill showboat-cmwilson05
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: showboat
Source: https://github.com/Cmwilson05/budget-manager/tree/main/.claude/skills/showboat
Command: npx skills add https://github.com/Cmwilson05/budget-manager --skill showboat-cmwilson05

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables teams to produce documentation that combines narrative explanations with executable code blocks, capturing real outputs to create verifiable, reproducible lab-like documents.

Core Features & Use Cases

  • Generates Markdown documents that narrate steps and run commands live, recording both inputs and outputs for easy verification.
  • Supports a literate programming style where readers can audit the exact commands and results, making tutorials, experiments, and tutorials trustworthy.
  • Use cases include building reproducible tutorials, lab notebooks for software workflows, and step-by-step runbooks that others can re-run.

Quick Start

Install or call the showboat CLI, then initialize a new demo markdown with a descriptive title and begin adding notes and executable blocks.

Frequently Asked Questions about showboat

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

FAQPage Schema
How do I create reproducible documentation with embedded command outputs in Markdown?

You can create reproducible documentation by using a CLI to execute commands and embed their live outputs directly into Markdown files. This ensures readers can verify exact inputs and results within tutorials and lab notebooks.

What is literate programming for tutorials and how does it capture command results?

Literate programming for tutorials combines narrative explanations with executable code blocks. It captures real-time command results, allowing readers to audit exact inputs and outputs to verify the reproducibility of software workflows.

How do I build a verifiable lab notebook that runs commands and records outputs?

Build a verifiable lab notebook by initializing a Markdown document and appending executable blocks. The system runs commands live, recording both the input commands and their real-time outputs for easy verification.

Do I need a specific CLI to generate executable Markdown documentation?

Yes, generating executable Markdown documentation requires the showboat CLI. You also need a project structure with Markdown documents and optional scripts, references, or assets folders to manage the workflow.

Can I use this approach to create runbooks that others can re-run step by step?

Yes, you can create step-by-step runbooks that others can re-run. The system supports generating documents where readers can audit exact commands and results, making runbooks trustworthy and reproducible.

What is the best way to verify that tutorial commands produce the documented results?

The best way to verify tutorial commands is to use a system that executes commands live and records their actual outputs. This captures exact results directly within the Markdown documentation, ensuring verifiable reproducibility.