mdspecExecutable Markdown Testing

Documentation drifts from code. READMEs show commands that no longer work. API examples break silently. mdspec makes your docs executable — if the example is wrong, the test fails.

Get Started

GitHub

Executable Docs

Turn CLI documentation into tests. Console code fences become runnable test cases with expected output assertions.

Pattern Matching

Match dynamic output with ellipsis wildcards, regular expressions, and named captures that can be reused across commands.

Persistent Context

Environment variables, working directory, and bash functions persist across code blocks within a test file.

Plugin System

Replace bash subprocess execution with in-process plugins for up to 8x faster test runs.

REPL Testing

Test interactive shells and REPLs with persistent subprocess mode, PTY support, and OSC 133 completion detection.

Framework Integration

Run markdown tests through Vitest or Bun alongside your TypeScript test suite.

Early release (0.x) -- API may evolve before 1.0. Requires Bun >= 1.0 and bash/POSIX shell (macOS/Linux; Windows via WSL).