mcpField
R
runbook-generator

runbook-generator

github.com/alirezarezvaniCloud & DevOps28.9k606 installsUpdated 2d ago
Repository

About runbook-generator

runbook-generator is a command-line skill for DevOps and site reliability teams. It creates an operational runbook skeleton from a service name, ready for service-specific deployment, incident response, maintenance, and rollback details.

Key features

  1. 01Generate a skeleton from a service name
  2. 02Include start, stop, health, and rollback sections
  3. 03Provide escalation and incident-handling placeholders
  4. 04Include deployment and incident-playbook templates

Use cases

  1. 01Create a baseline for a service without a runbook
  2. 02Standardize operations documentation across teams
  3. 03Prepare consistent operations docs for on-call onboarding
  4. 04Scaffold repeatable runbooks for new services

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/alirezarezvani/claude-skills --skill runbook-generator

After installing, type/runbook-generatorin Claude Code to confirm it loaded.

Bundled filesreferences/runbook-templates.mdscripts/runbook_generator.py

Details

From the project README

Runbook Generator

Tier: POWERFUL
Category: Engineering
Domain: DevOps / Site Reliability Engineering

Overview

Generate operational runbooks quickly from a service name, then customize for deployment, incident response, maintenance, and rollback workflows.

Core Capabilities

  • Runbook skeleton generation from a CLI
  • Standard sections for start/stop/health/rollback
  • Structured escalation and incident handling placeholders
  • Reference templates for deployment and incident playbooks

When to Use

  • A service has no runbook and needs a baseline immediately
  • Existing runbooks are inconsistent across teams
  • On-call onboarding requires standardized operations docs
  • You need repeatable runbook scaffolding for new services

Quick Start

# Print runbook to stdout
python3 scripts/runbook_generator.py payments-api

# Write runbook file
python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md

Recommended Workflow

  1. Generate the initial skeleton with scripts/runbook_generator.py.
  2. Fill in service-specific commands and URLs.
  3. Add verification checks and rollback triggers.
  4. Dry-run in staging.
  5. Store runbook in version control near service code.

Reference Docs

  • references/runbook-templates.md

Common Pitfalls

  • Missing rollback triggers or rollback commands
  • Steps without expected output checks
  • Stale ownership/escalation contacts
  • Runbooks never tested outside of incidents

Best Practices

  1. Keep every command copy-pasteable.
  2. Include health checks after every critical step.
  3. Validate runbooks on a fixed review cadence.
  4. Update runbook content after incidents and postmortems.

Comments

Markdown supported