Infrastructure Workflows
Built with Markdown

Runme combines your docs with everything great about scripting and pipelines.

Try now ▶️:
$ brew install runme && runme open

Open source and compatible with the dev toolchain. Runme integrates perfectly with your existing toolkit.

Make Markdowns Interactive

$ brew install runme
$ npx runme
Runme for VS Code

Bring your Tools

Works with Helm, Terraform, Ansible, Docker, SSH, any many other cloud-native projects and services.
Bring your Tools

Notebook & CLI

Choose the 'click to play' notebook experience or jump right into the terminal with the CLI.

Kernel Architecture

Runme is like Jupyter but with a Shell/Bash Kernel, shared environment sessions, lightweight dependencies, and both a CLI and notebook UI.
Kernel Architecture

Many Languages

Supports running commands/snippets written in Javascript, Typescript, Shell, Lua, Perl, Python and Ruby. More to come!
Many Languages

Open Platform & Standards

Built on the VS Code platform, open source and 100% markdown compatible. Also runs in Codespaces, Gitpod, VSCodium, and in the browser using coder/code-server.
Open Platform & Standards

Continuous Integration

Test your runbooks and docs against your app using the Runme CLI, or our GitHub Action.
Continuous Integration

Runme works with your pre-existing documentation, so no extra infrastructure to build, maintain, or manage.
No extra TCO or bus factor.

Popular Use Cases

Mission Control Dashboards
Consolidate the commands/code needed to modify and monitor cloud infrastructure with deeply integrated admin interfaces.
Interactive External Docs
Transform a MkDocs or Docusaurus website into interactive docs for your CLI tool, helping users get started quickly.
Operational Runbooks
Sequencial workflows for onboarding, customer support or on-call handling outages and saving output artifacts for incident reports.

Services by Stateful

The platform that make it easy and safe to collaborate as you operate.

State for your Notebooks

Save cell runs with outputs and metadata, create sharable links (ideal for distributed teams and timezones). Share on Slack for real-time team debugging.

Training and Support

Let's get the most out of your runnable docs and tribal knowledge sharing, migrate from your wiki and work through any blockers we meet along the way.

Enterprise Ready

Streamlined for robust user and group management and integrations with key enterprise tools like a SIEM. Permissioning for sensitive notebook cells to avoid costly accidents.

Early Access Program

Get immediate access to newly deployed features and functionality both in the Runme toolchain and in Stateful, search, ChatOps, health metrics and lots more.

Loved by Engineers

Runme makes it easy to keep documentation as the source of truth for what I actually run. Anything that's more than a line, and even a bunch of one liners, now goes into a MD file, and I can quickly and easily (re)run them whenever I need. It saves me from dozens of copy/paste mistakes a day, and I cannot live without it any more!
Runme makes your project documentation a step by step runbook. Even for non-technical users. Thanks for creating such a neat utility.
Mike Lockhart
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.
Runme organized our docs and technical processes. This is a fantastic tool for both solo development and team work. And the best part is it's all markdown, with 100% compatibility with other tools. Runme is already irreplaceable in my workflow.

Supported by the community

Interested in contributing?

Github stars
Discord users