# runmedev/runme

DevOps Notebooks Built with Markdown

Repository: https://github.com/runmedev/runme
Canonical: https://ross.abutalabs.com/products/runme
Homepage: https://runme.dev
Language: Go
License: Apache-2.0
License Family: permissive
Topics: cloud, devops, notebooks, workflows, markdown
Last push: 2026-08-23T18:00:57+00:00

## Health v2 (maintenance only)
Score: 94/100 (v2, computed 2026-09-03T02:39:23.370411+00:00)
- activity 99, release rhythm 85, longevity 100
- inputs: {"age_days": 1507, "days_push": 10, "days_rel": 20, "gap_med": 5.5, "n_releases_24m": 61}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2146, forks 88 (observed 2026-08-28T04:06:18.536260+00:00)

## What it is
Runme is an open-source tool that makes Markdown documentation executable, running shell commands and code snippets directly from fenced code blocks in runbooks and docs. It provides a CLI, VS Code extension, and notebook UI backed by a shell kernel, enabling runnable DevOps runbooks that can be tested in CI/CD.

## Use cases
- run markdown runbooks step by step from the terminal
- execute code snippets inside README and docs files
- turn operational docs into interactive notebooks
- test markdown documentation in CI/CD pipelines
- keep runbooks from going stale with executable instructions
- run devops workflows with terraform, helm, and docker from notebooks

## When to choose
- your team maintains runbooks or operational docs in markdown that drift out of date
- you want a Jupyter-like notebook experience with a shell kernel
- you need to validate documentation commands on every commit
- you prefer docs that stay in plain markdown and work with git

## When to avoid
- you need a full data-science notebook with rich plotting and Python kernels
- your docs are not stored as markdown
- you only need a static documentation site generator

## Facets
- artifact type: cli-tool
- maturity: active
- function: cli, developer-tools, workflow-automation, documentation, terminal-ui
- domain: developer-tools, documentation, cloud-computing
- platform: cli, windows, cross-platform, editor-plugin
- tags: notebooks, markdown, runbooks, shell-kernel, vscode-extension, ci-cd, devops-notebooks, devops, automation, macos, linux, docker, web-server

## Member repositories
- runmedev/runme (main) score 94

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:18.536260+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T02:51:10.961078+00:00, confidence not recorded.
  - readme: https://github.com/runmedev/runme (fetched 2026-08-28T04:06:18.536260+00:00, sha 6a28338e248c)
  - homepage: https://runme.dev (fetched 2026-08-29T10:31:12.841411+00:00, sha bbd153fd33a0)
  - site_page: https://docs.runme.dev/getting-started (fetched 2026-08-29T10:31:12.844176+00:00, sha 94d2d9e76aed)
  - site_page: https://docs.runme.dev (fetched 2026-08-29T10:31:12.848119+00:00, sha 7c9aa9ff5e2b)
  - site_page: https://runme.dev/blog/readmeops-testing-docs-in-ci (fetched 2026-08-29T10:31:12.850308+00:00, sha cb49df9abc65)
  - site_page: https://docs.runme.dev/installation (fetched 2026-08-29T10:31:12.852565+00:00, sha 39d313a3c5e7)
- Data as of 2026-08-30T08:39:29.467469+00:00.