▶ Welcome
Why Runme? ⚡️
The goal of Runme is to enable engineers to capture an operational process as a reliable, refinable, reusable asset we call a Runme Notebook. All DevOps engineers have experienced the frustration of not being able to get work done because documentation is out of date, hard to find and not able to integrate with cloud native processes. By building, and curating, reliable Runme Notebooks, you can break through this frustration and open up hours of productivity!
What is Runme?
Runme makes Markdown documentation actually runnable. Runme is a Cloud-native Shell Kernel with a notebook, editor, terminal, and CLI interface. Runme helps you build and curate Notebooks and also run them making it easy to automate step-by-step instructions especially in cloud-native environments. Runme Notebooks are perfect for capturing and persisting operational knowledge making operational docs reliable and less likely to become outdated.
Another way to think about it:
💡 Runme is like Jupyter but with a Shell/Bash Kernel and lightweight dependencies.
Built on Open Technologies & Standards
Runme is Markdown compatible (and superset) and open source licensed under Apache 2.0. We also work hard to use open standards for interoperability. Get more details in our open source section.
StarsAll the code for Runme can be found in 4 repositories on Github:
Introduction video
A fun introduction to the problem Runme is trying to solve.
Runme in 2 minutes
A quick hands on example of Runme in action.
Jump forward
What makes a Runme Notebook?
When you create a Notebook using Markdown, and then either open it's Notebook form in VS Code (or use the CLI) we are adding important capabilities that don't exist in a pure Markdown rendering.
The Notebook interface makes:
- commands and code executable
- behavior and output configurable (stored transparently in the Markdown)
- commands aware of .ENV dependencies
A great example of this is when you specify the mimetype, that config metadata tells the Notebook to automatically render an image or a sortable table instead of text for output. We can also interpret URL's to cloud console's as an interactive dashboard UI.
Runme's architecture
Runme is built on the VS Code platform running in Codespaces, Coder's code-server, Google IDX, GCP Cloud Editor, Gitpod, VSCodium, etc. Under the hood, much like other Notebook technologies such as Jupyter, you can read more on the Architecture page.
What's next?
- First you need to install Runme for the client you want to use.
- Next follow the getting started guide
If you've already done that, skip to configuring Notebooks or our guides.