Favicon of runme

runme

Run shell, Python, JavaScript, and other code blocks embedded in markdown files. Perfect for executable documentation, runbooks, and step-by-step guides.

Runme transforms markdown from static documentation into executable workflows. Instead of manually copying and pasting commands from your README or runbook, you can discover and execute code snippets directly within your markdown files.

The tool supports multiple programming languages including Shell/Bash, Python, Ruby, JavaScript/TypeScript, Lua, PHP, Perl, and many others through its shebang feature. This makes it ideal for creating reliable operational documentation that stays current and reduces the risk of outdated instructions.

Key capabilities include:

  • Execute code blocks with a single command using the CLI
  • Maintain environment variables across multiple code cell executions
  • Pipe output from one cell into subsequent cells, just like a terminal session
  • List all available runnable workflows in your project
  • Preview code without executing it
  • Compatible with existing task definitions like Makefiles, NPM scripts, and Gradle
  • 100% markdown-native—your documentation remains readable and version-controllable

Whether you're managing runbooks, playbooks, or documentation that requires users to follow step-by-step instructions, Runme ensures that each step actually works. The tool literally runs your markdown, making it an excellent solution for teams that need reliable, executable documentation without maintaining separate automation tools.

Install

Brew
$ brew install runme

Features

JSON outputScriptable

Media

Pros

4
  • Executes code blocks directly from markdown files.
  • Supports a wide variety of programming languages and runtimes.
  • Retains environment variables across executions.
  • Allows piping output between code cells.

Related tools

Share:

Auto-fetched .

Recent releases

Similar to runme

Favicon

 

  
 
Favicon

 

  
 
Favicon