Skip to main content

Getting Started

Welcome to Runme! This is your starting point for a journey with us. Here, we will guide you through all the essential information you need to learn about Runme to ensure you get the most out of our platform easily and quickly. Let’s dive in!

Overview of Runme​

Runme is an easy solution for runbooks, playbooks, and documentation that requires users to complete runnable steps one at a time. Thus making operational documentation dependable. It enables users to execute interactive runbooks using Markdown. It also incorporates a feature that enables users to run code and commands inside your fenced code blocks.

Installation​

Runme can be installed using VS Code, Docker, or your CLI. To start installing Runme for your machine, proceed to our installation page.

UI Overview​

Integration with Other tools​

Runme integrates seamlessly with other tools to make the job of DevOps and SREs more easier and exciting. Some of the common tools are Docker, Ansible, Terraform, Kubernetes, Dev containers, Github, Fresh App, etc. To learn more about Runme’s integration with other tools, see our integration page.

Support​

Do you need assistance in getting started? Get in touch with us on Discord to provide answers to your questions and give you information on all the necessary details you need to enjoy working with Runme.

Next Steps​

Thank you for choosing Runme! We are sure that you will enjoy every bit of action you perform with Runme. To further your knowledge about Runme you can check out: