In simple English
Standard instruction files often get outdated because people forget to test them. This tool turns any documentation file into a runnable script. You click a button or type a command to execute the code blocks inside your text. It saves time when setting up servers or onboarding new team members. The software is free and open-source under the Apache-2.0 licence.
What it is
Runme is a command-line utility and editor extension that parses Markdown files and executes the code snippets found inside them. It supports multiple programming languages through shebang lines and preserves environment variables between steps.
What it is good for
Solo builders who want to turn their project README files or deployment guides into dependable checklists that actually run without copying and pasting.
- Turns static documentation into interactive scripts.
- Keeps environment variables active across multiple steps.
- Works with standard Markdown files you already use.
- Requires command-line familiarity to set up and run.
- Can execute risky commands if instructions are poorly written.
- Relies on correct code block syntax in your documentation.
manual copy-pasting of commands from README files into a terminal
Homebrew (a package manager for installing software on MacOS and Linux)
- casey/just36k stars
Just is a handy command runner that saves project commands, but it uses a custom syntax instead of Markdown files.
- Schniz/fnm27k stars
Fast Node Manager helps manage multiple Node versions, but it focuses on environment setup rather than running documentation scripts.
- sphinx-doc/sphinx8.1k stars
Builds a documentation website, and a PDF, from text files and from the comments beside the code.
- facebook/docusaurus67k stars
A static site generator from Meta that turns Markdown files into a documentation website.
brew install runme