Skip to content

Operations Runbook

Scaffolds an operations runbook with service overview, dependency map, operational procedures, and escalation paths. Optionally includes an incident response playbook. Designed for on-call engineers and SRE teams managing production services.

Namerunbook
Version0.1.0
Categoryoperations
LicenseApache-2.0
Personaoperations
Tagsrunbook, operations, incident-response, escalation, sre
Sourcetemplates/runbook

Render it

Three front doors, one catalog. Pick whichever suits the caller.

# CLI
npx @nanohype/sdk render runbook --out ./my-app

# SDK
import { LocalSource, renderTemplate } from "@nanohype/sdk";
const result = await renderTemplate(source, "runbook", variables);

# MCP — from an agent
get_template({ name: "runbook" })

Variables

Required

ProjectName string
Kebab-case project name used as the document directory Must be lowercase kebab-case starting with a letter.
ServiceName string
Human-readable service name for document titles

Optional

IncludeIncidentResponse bool — defaults to true
Include an incident response playbook
OnCallTool string — defaults to pagerduty
On-call management tool (pagerduty, opsgenie, grafana-oncall)

What it produces

5 files. Placeholder names such as __APP_NAME__ are what the renderer substitutes into.

runbook/dependencies.yaml
runbook/escalation.yaml
runbook/incident-response.md
runbook/overview.md
runbook/procedures.md

Composes with

Composites that use it

  • Product Launch — Full product launch kit spanning engineering, design, QA, product, marketing, and operations.