Technology · Ebook

Runme: Executable Markdown for DevOps

by Shriira Press

Runme is a CNCF sandbox project that turns ordinary Markdown — READMEs, runbooks, setup guides — into interactive, runnable notebooks. The shell and code blocks you already write become cells you can execute in a VS Code notebook, from a command-line tool, or headless inside CI. Its target is documentation bitrot: instructions that quietly drift out of sync because no one runs them. By making the doc itself the thing that runs, Runme keeps operational knowledge honest, testable, and reproducible. This book covers the bitrot problem and the executable-document idea, Runme's serializer-kernel-runner architecture, cell annotations and named workflows, sessions and exported environment state, the CLI and headless execution, runbooks in CI/CD, and the practices that make Runme worth adopting.

Contents

1. 1Preface
2. 2Chapter 1 — Documentation That Runs
3. 3Chapter 2 — Inside Runme's Architecture
4. 4Chapter 3 — Cells, Annotations, and Named Workflows
5. 5Chapter 4 — Sessions and Environment State
6. 6Chapter 5 — The Command Line and Headless Runme
7. 7Chapter 6 — Runbooks in CI/CD
8. 8Chapter 7 — Runme in Practice