Skip to main content
skill CX Codex

runbook-generator · onewave-ai — Claude Code skill: what it does and setup

The runbook-generator skill inspects a project’s code and deployment configuration, then writes an operational runbook.md. Use it to document releases, incident response, or disaster recovery.

MIT 252 installs ★ 440 updated 2026-10-20

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add OneWave-AI/claude-skills --skill runbook-generator -a claude-code
Open on GitHub

What runbook-generator does

The skill searches the repository for infrastructure and application configuration, then reviews IaC, containers, CI/CD, monitoring, and deployment scripts. It uses a supplied template to create runbook.md with nine sections, an architecture diagram, and a table of contents. The required document is substantial: at least 500 lines.

Its workflow includes file-discovery patterns, an output template, and writing rules. It checks whether referenced paths and scripts exist, labels details that need verification with [VERIFY], and marks gaps with [ACTION REQUIRED]: .... It must not invent infrastructure facts. As a result, the generated guide can also surface follow-up work for the project team.

The skill uses Read, Glob, Grep, Bash, Write, and Edit. It saves runbook.md in the project root or a directory the user chooses. Commands in the guide should come from the codebase and include expected outputs, so the repository needs to contain evidence for the procedures being documented.

What it helps with

  • turn deployment configuration into step-by-step release procedures
  • document incident response and rollback actions
  • write backup and disaster recovery instructions
  • identify gaps in operational documentation
  • check whether runbook references point to real files and scripts

Example prompts for the agent

  • Create a runbook.md for this project with deployment and rollback procedures.
  • Review this repository and write incident response guidance for the service.
  • Inspect the project configuration and draft recovery steps with commands.

How to install runbook-generator

1Skills CLI (Vercel)

npx skills add OneWave-AI/claude-skills --skill runbook-generator -a claude-code

2Manually: put the files in place

~/.claude/skills/runbook-generator/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/runbook-generator/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about runbook-generator

How do I install runbook-generator in Claude Code?

Run npx skills add OneWave-AI/claude-skills --skill runbook-generator -a claude-code. The skill file is at ~/.claude/skills/runbook-generator/SKILL.md.

What does runbook-generator do?

It examines a project’s code and configuration, then writes an operational runbook.md with procedures, commands, and an architecture diagram. It flags details that need checking and sections with outstanding gaps.

How long is the generated runbook, and what does it contain?

The instructions call for a document of at least 500 lines, with nine sections and a complete table of contents. Its contents are adapted to the information found in the project.

Source text

SKILL.md · MIT
---
name: runbook-generator
description: Generates comprehensive operational runbooks for any system or process. Reads codebase, infrastructure config, and deployment scripts to produce structured runbook.md files formatted for on-call engineers. Use when you need operations documentation, incident response guides, deployment procedures, or disaster recovery plans.
tools: Read, Glob, Grep, Bash, Write, Edit
model: inherit
---

# Runbook Generator

Generate a comprehensive operational `runbook.md` from a system's codebase, infrastructure config, and deployment scripts -- written for on-call engineers working incidents, deployments, and routine operations at 3am.

## Contents
- `references/discovery-patterns.md` -- Glob/Grep patterns and config files to inspect during discovery.
- `references/output-template.md` -- The full 9-section runbook.md structure to populate.
- `references/writing-style.md` -- Clarity, urgency, completeness, formatting, and accuracy rules plus output requirements.

## Workflow

1. Discover the system. Run the Glob patterns in `references/discovery-patterns.md` (Step 1) to identify the stack and infrastructure.
2. Read key configuration. Open and analyze the config files listed in `references/discovery-patterns.md` (Step 2): IaC, containers, CI/CD, app config, deploy scripts, monitoring, migrations, load balancers, docs.
3. Identify operational behavior. Run the Grep patterns in `references/discovery-patterns.md` (Step 3) to surface health checks, metrics, caching, jobs, migrations, rollback, scaling, backups, TLS, secrets, alerting, and more.
4. Generate the runbook. Produce `runbook.md` following the structure in `references/output-template.md`. Cover all 9 sections; adapt content to what discovery found; never include purely speculative sections.
5. Apply writing standards. Follow every rule in `references/writing-style.md` -- copy-pasteable commands, expected outputs, sequential steps, P1-first ordering, tables for structured data, and the accuracy rules.
6. Verify and flag gaps. Confirm referenced paths and scripts exist. Mark unverifiable details with `[VERIFY]` and missing sections with `[ACTION REQUIRED]: ...` so the runbook doubles as a gap analysis.

## Output

Write `runbook.md` to the project root (or a directory the user specifies). It must be 500+ lines, cover all 9 sections, contain real commands derived from the codebase, include at least one architecture diagram, carry a complete table of contents, and never fabricate infrastructure details. See `references/writing-style.md` for the full output checklist.

© OneWave-AI · MIT · OneWave-AI/claude-skills

Similar skills

All skills for DevOps and infrastructure →

runbook-generator by other authors comes first.

runbook-generator Alireza Rezvani runbook-generator generates an operational runbook skeleton from a service name, covering deployment, incidents, maintenance, and rollback. Useful before launching a new service. CX Codex +1 600installs incident-runbook-templates Seth Hobson The incident-runbook-templates skill builds step-by-step incident runbooks for detection, triage, mitigation, recovery, escalation, and status updates. CX Codex +1 10,900installs runbook official anthropics This skill turns a recurring operation into a step-by-step runbook with verification, failure handling, rollback, and escalation guidance. CX Codex +1 3,300installs runbook-creation devops-skills runbook-creation writes operational runbooks, SOPs and recovery procedures that an on-call engineer can follow while the incident is still open. CX Codex +1 388installs launch-runbook rampstackco The launch-runbook skill structures a product or website launch: pre-go-live checks, deployment sequencing, DNS cutover steps, post-launch verification, and rollback triggers. CX Codex +1 325installs backup-restore-runbook-generator patricio0312rev The backup-restore-runbook-generator skill builds database disaster-recovery runbooks with backup scripts, restore steps, and validation checks. Use it when planning recovery procedures. CX Codex +1 294installs eng-runbook nexu-io eng-runbook generates a single-page HTML operations runbook with alerts, incident checklists, and terminal commands. Useful for on-call engineers and SRE teams. CX Codex +1 231installs

From the same set185

The whole set →
overnight-repo-auditor overnight-repo-auditor runs an autonomous overnight code audit covering security, performance, accessibility, and dependencies without prompting for confirmation. CX Codex +1 253installs cowork-deal-room The cowork-deal-room skill reviews deal-room files in five stages and produces risk findings, term comparisons, and negotiation guidance. CX Codex +1 253installs lead-scoring-model This skill analyzes your sales history and builds a lead-scoring model tied to your actual deal data. It generates documentation with scoring dimensions, thresholds, and a CRM implementation guide. CX Codex +1 253installs incident-responder The incident-responder skill investigates production incidents by checking logs and recent changes, classifying severity, and preparing recovery guidance and a report. Use it during an outage and for follow-up. CX Codex +1 253installs data-pipeline-builder data-pipeline-builder turns source, destination and transformation notes into a runnable ETL/ELT pipeline: Python or SQL code, an Airflow DAG, quality checks and a spec file. CX Codex +1 252installs roi-calculator roi-calculator turns your current costs, manual hours and hourly rates into a written ROI report on an AI project, with payback and sensitivity cases. CX Codex +1 252installs investor-update-writer investor-update-writer generates monthly and quarterly updates for startup investors into a structured investor-update.md file using metrics, milestones, and runway. CX Codex +1 252installs onboarding-checklist Generates phased client onboarding checklists in onboarding-checklist.md with task ownership, criteria, and five email templates for SaaS, agencies, or consulting. CX Codex +1 251installs

Project sponsors

Companies that keep this analytics open