statefulhq/runme repository overview

⁠Runme runs Markdown

Runme⁠ is a tool that makes runbooks actually runnable, making it easier to follow step-by-step instructions. Users can execute instructions, check intermediate results, and ensure the desired outputs are achieved. Authors can create predefined golden paths and share them with others. Runme combines the guardrails of a pipeline with the flexibility of scripting, where users can check intermediary results before moving on.

Runme achieves this by literally running markdown (ubiquitous for docs inside repos). More specifically, Runme runs your commands inside your fenced code blocks (shell, bash, zsh). It's 100% compatible with your programming language's task definitions (Makefile, Gradle, Grunt, NPM scripts, Pipfile or Deno tasks, etc.). Runme persists your runbooks in markdown, which your docs are likely already using.

⁠Installation

Pull the image directly from Docker Hub via:

$ docker pull statefulhq/runme
# on MacOS Silicon
docker pull  --platform linux/x86_64 statefulhq/runme

Then execute Runme for example via:

$ docker run docker.io/statefulhq/runme:latest --version

⁠More Information

For more information on the Runme CLI and its commands and parameters, please checkout the docs⁠

⁠Examples

You can find an exhaustive list of examples in the official Runme documentation⁠ with examples demonstrating various use cases of Runme.

⁠Feedback

Let us know what you think via GitHub issues⁠ or submit a PR. Join the conversation on Discord⁠. We're looking forward to hear from you.

⁠Community

The Runme community is growing, join us!

• Ask questions and be curious with us on Discord⁠
• Read about real live Runme examples and use cases in our blog⁠
• Meet the developers, learn about the roadmap and recent developments in our Community Meetings⁠
• Subscribe for updates to our newsletter⁠

⁠LICENCE

Apache License, Version 2.0