Skip to content
Search

Runme

lastmod 2026-01-26created 2026-01-261 edits

A CLI tool that turns code blocks in Markdown into executable workflows

About

  • Developed to make code snippets in documents actually executable, improving the usefulness/reliability of runbooks, operations documents, and READMEs
    • Runs Markdown code blocks as-is, so you can easily follow and verify a document step by step
    • Run commands, check intermediate results, and confirm whether the desired output was achieved
  • Supports many runtimes such as Shell/Bash, Python, JavaScript/TypeScript, and Ruby, based on shebang
  • Keeps environment variables and execution context when running code cells, allowing step-by-step execution like a terminal session
  • Also supports a pipeline-style execution flow that passes the output of a previous cell to the next cell
  • Fully compatible with existing task definitions such as Makefile, npm scripts, Gradle, and Deno task
  • Browse, run, and verify executable workflows in documents with the run, list, and print commands
  • Reduces the bitrot problem of operations documents; especially suited to practical documents that require step-by-step execution
    • bitrot: the phenomenon where documents or code drift from the real environment over time and gradually lose trust
  • Can be installed via Homebrew, npm, Go install, a single binary, etc.
  • Apache 2.0 license

See also

Favorite site

author Zer0 sitemap