▶ Runme runs Markdown

Execute commands inside your runbooks, docs, and READMEs.
Documentation
View on GitHub
$ npx runme$ brew install stateful/tap/runmeRunme for VS Code

Runbooks for Humans

CLI Runner
Run tasks and workflows from the terminal using the runme binary in any environment.
CLI Runner
Notebook Runner
Get the `click to play` notebook experience for running your markdown in the browser, or VS Code.
Notebook Runner
CI/CD for Docs
Test your docs against your app using the runme binary, or our GitHub Action.
CI/CD for Docs
Integrations
Expand notebooks into the cloud: GitHub, Vercel, Begin, Deno Deploy and more.
Integrations
Bring your Tasks
Works with Makefile, NPM/Pipfile Scripts, Rake, Gradle, Grunt/Gulp, etc.
Bring your Tasks
Supported by the community
6k
Installs
330
GitHub Stars
280+
Discord Users
Interested in contributing? Start building today.

Loved by Developers

I tried your extension after seeing this post and it's a great tool so I'll give you a 5 star rating on VS Code marketplace! I hope you a successful continuation for this clever and useful project.

Vincent Amstoutz

This is actually insanely cool.

Empole

Damn, this'll be a godsend for all those Docker commands.

xeonm

This is super exciting! I often find myself wishing that I could use Jupyter Notebooks in other contexts... RUNME is an ideal solution here, and brings us back towards literate computing for broader devops.

Mike Lockhart

Get started, run a README.md
Explore the docs
$ npx runme$ brew install stateful/tap/runmeRunme for VS Code
Star and Contribute
All Runme code is open source and APL-2.0 licensed. We love contributions.
Join the community
Join the Runme Discord Community for instant support and rich conversations about the future of readme-ops.
Stay in touch
We want to stay connected with our users on Twitter. Follow @runmedev for all the latest updates.