runme turns Markdown files into executable, interactive runbooks. Shell fenced code blocks inside a README.md or any other Markdown file become runnable cells that you can execute from a CLI, a VS Code extension, or a standalone desktop app, with outputs captured back into the session.
The project is built around the idea that the documentation developers already write — install steps, local dev loops, deployment commands, on-call runbooks — is executable in principle but broken in practice because copy-pasting into a terminal loses context, order, and environment. runme addresses this by parsing Markdown into a cell-based notebook model and attaching metadata per block through standard code fence attributes: working directory, whether to require confirmation, environment variable propagation, shell to use, whether to stream output, and so on. A single runbook can mix bash, PowerShell, JavaScript, Python, and other interpreters, and variables exported in one cell are available to later cells.
runme integrates with VS Code as a notebook renderer, ships a CLI (runme run <task>) for CI, and has a cloud component for team runbook sharing and audit. Typical use cases include onboarding guides, incident playbooks, and opinionated “how to ship this service” documents that platform teams want to stay in sync with reality. It is Apache-2.0 licensed and written in Go.
