BLOG: Roll up Terminals Into A Knowledge Base

DevOps Notebooks
Built with Markdown

Codify your operational process as cloud-native, testable, interactive documentation.

Getting Started icon
Getting Started
Get Runme setup for VS Code, CLI, Web, Docker or with your CDE.
Usage icon
Usage
How to use all the available features and integrations for crafting reliable Notebooks.
Configuration icon
Configuration
An overview of the available config for Notebooks and cells, including identity, auto-save and shebang.
$ brew install runme && runme open

Open source, open standards, Apache License Version 2.0 and compatible with your existing toolchain.

Make Markdowns Interactive

$ brew install runme
$ npx runme
Runme for VS Code

Hello World

Make your first Notebook (create and open a Markdown file), run bash from a cell, display output from Google cloud and generate and share artifacts from your session. Then check it into your Git repo for others to use.

Cloud Native

Integrated with your favorite cloud providers to bring important web interfaces directly into your notebooks. Check out the GCP example below, with AWS and Azure coming soon.

Bring your Tools

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

Many Languages

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

GitOps and CI

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

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

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

Guides

Explore step-by-step examples with all the tools in your DevOps stack.

Bash Scripts icon
Bash Scripts
Run bash scripts directly within your Markdown files as a Runme Notebook.
Devcontainers icon
Devcontainers
Connect your Runme Notebook to a Devcontainer.
Test in CI icon
Test in CI
Run your Notebooks as tests in your CI/CD pipelines to keep them from bitrot.
Docker icon
Docker
Runme Notebooks for Docker workflows.
Python .venv icon
Python .venv
Create and use a virtual environment for running Python commands.
Terraform icon
Terraform
Runme Notebooks for Terraform workflows.
Dagger icon
Dagger
Easily write, develop, and run Dagger modules and pipelines within a notebook environment
K8s with Helm icon
K8s with Helm
Runme Notebooks for k8s/Helm workflows.
K8s with Argo CD icon
K8s with Argo CD
Setup and interact with Argo using Runme Notebooks.
AWS icon
AWS
Manage AWS resources and perform operations from your Markdown environment.
BigQuery icon
BigQuery
Interact with BigQuery in GCloud and render sortable tables.
Cloud Run icon
Cloud Run
Manage Google Cloud Run resources and perform operations from your Markdown environment.
GCP icon
GCP
Manage Google Cloud resources and perform operations from your Markdown environment.

Loved by Engineers

Runme has quickly become an indispensable tool in our tech stack. The ability to seamlessly pair natural language explanations with commands and rich output creates the ideal user experience for integrating AI into our DevOps workflow. It's revolutionized how we document and execute our processes, making everything more efficient and accessible.
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?

46.2k
Installs
1.1k
Github stars
640+
Discord users