Description:
Execute commands inside your runbooks, docs, and READMEs
|
|
Type: Formula
|
Latest Version: 3.16.4@0
|
Tracked Since: Dec 27, 2025
|
|
Links:
Homepage |
formulae.brew.sh
|
|
Category: Developer tools
|
|
Tags:
cli
documentation
automation
devops
shell
|
|
Install:
brew install runme
|
About:
Runme is a CLI tool that parses and executes shell commands directly from markdown files, READMEs, and runbooks. It enables interactive, executable documentation by allowing users to run code snippets in isolated terminal sessions without manual copying. This bridges the gap between documentation and execution, making tutorials and runbooks directly actionable.
|
Key Features:
- Execute shell commands from markdown files
- Isolated terminal sessions for command execution
- Supports environment variable configuration
- Integrates with existing documentation workflows
- Provides a CLI for automation and scripting
|
Use Cases:
- Running tutorial steps from project READMEs interactively
- Executing operational runbooks for DevOps tasks
- Testing and validating code snippets in documentation
|
Alternatives:
-
mdx
– MDX is a JSX-based markdown compiler for React, not a CLI tool for executing shell commands.
-
bash
– Native shell requires manual copying and pasting of commands from documentation.
|
| Detected |
Version |
Rev |
Change |
Commit |
| Dec 27, 2025 5:20pm |
3.16.4 |
0 |
VERSION_BUMP |
35956e3b |
| Oct 9, 2025 4:05pm |
|
0 |
VERSION_BUMP |
ffbe0587 |
| Sep 25, 2025 5:23pm |
|
0 |
VERSION_BUMP |
d1686d4e |
| Sep 16, 2025 10:17am |
|
0 |
VERSION_BUMP |
f61b1c7a |
| Dec 18, 2024 10:19am |
|
0 |
VERSION_BUMP |
57a38115 |
| Dec 3, 2024 4:09pm |
|
0 |
VERSION_BUMP |
a738e455 |
| Oct 8, 2024 10:20am |
|
0 |
VERSION_BUMP |
08ba041b |
| Sep 20, 2024 12:58am |
|
0 |
VERSION_BUMP |
9e9e5987 |
| Sep 19, 2024 5:37pm |
|
0 |
VERSION_BUMP |
a22df5cd |
| Sep 10, 2024 11:45pm |
|
0 |
VERSION_BUMP |
74edc2ea |
| Aug 28, 2024 8:35pm |
|
0 |
VERSION_BUMP |
c42fc137 |
| Aug 26, 2024 6:02pm |
|
0 |
VERSION_BUMP |
f0982537 |
| Aug 19, 2024 1:01pm |
|
0 |
VERSION_BUMP |
84a5e10c |
| May 13, 2024 1:37pm |
|
0 |
VERSION_BUMP |
bcaaf81a |
| May 7, 2024 5:44pm |
|
0 |
VERSION_BUMP |
c775038c |
| May 7, 2024 12:19pm |
|
0 |
VERSION_BUMP |
eeaccf51 |
| Apr 17, 2024 6:40pm |
|
0 |
VERSION_BUMP |
c15b0950 |
| Apr 17, 2024 2:09pm |
|
0 |
VERSION_BUMP |
aaaa5fa6 |
| Apr 5, 2024 9:22pm |
|
0 |
VERSION_BUMP |
e7a1d838 |
| Apr 5, 2024 5:05pm |
|
0 |
VERSION_BUMP |
6c6fa876 |
| Feb 9, 2024 6:48pm |
|
0 |
VERSION_BUMP |
20632605 |
| Feb 9, 2024 5:59pm |
|
0 |
VERSION_BUMP |
23a0a546 |
| Jan 26, 2024 2:35pm |
|
0 |
VERSION_BUMP |
beec4abf |
| Jan 5, 2024 1:09pm |
|
0 |
VERSION_BUMP |
9808538c |
| Jan 4, 2024 2:09pm |
|
0 |
VERSION_BUMP |
66051557 |
| Nov 29, 2023 10:42am |
|
0 |
VERSION_BUMP |
4bb51849 |
| Nov 10, 2023 12:00pm |
|
0 |
VERSION_BUMP |
278c5672 |
| Oct 19, 2023 4:47am |
|
0 |
VERSION_BUMP |
fa2a2d50 |
| Oct 6, 2023 9:09am |
|
0 |
VERSION_BUMP |
733c4714 |
| Aug 24, 2023 12:03pm |
|
0 |
VERSION_BUMP |
4455b438 |
| Aug 1, 2023 8:11am |
|
0 |
VERSION_BUMP |
f46034db |
|