runbook
Skill0 starsChanged 20 days agoMITView on GitHub
Write an operational runbook for one homelab service as a Markdown file, with the container, proxy host and DNS facts pulled from the live tools. Use when the user asks for a runbook, an SOP, or a document that explains how to operate, restart, roll back or troubleshoot one service.
25 other projects use a version of this.
Adopted by
Most recently taken up by
- nisarth/claude-skills-storetheir own version, first seen Nov 8, 2026
- AsiaOstrich/EngramGraphtheir own version, first seen Nov 8, 2026
- jocarrd/crux-agentstheir own version, first seen Nov 8, 2026
- Firzus/agent-skillstheir own version, first seen Nov 1, 2026
- AsiaOstrich/universal-dev-standardstheir own version, first seen Nov 1, 2026
- Big-LAORE/Biblioth-que-de-skillstheir own version, first seen Nov 1, 2026
Used with
Projects with it also use incident, discover and 8 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
JkudjoSkillincident
Production incident response — structured triage, hypothesis tree, safe remediation, incident record
Also in 4 projects that use this
anombyte93Skilldiscover
Phase 1 of the prd-taskmaster pipeline: brainstorm-driven discovery. Delegates to superpowers:brainstorming in Interactive Mode (one adaptive question at a time), or self-brainstorms in Autonomous Mode when no user is present. Intercepts before the brainstorming chain hands off to writing-plans — this skill owns the exit. Extracts constraints, calibrates scale (Solo / Team / Enterprise), and advances the pipeline to GENERATE.
Also in 4 projects that use this
asterkinSkilladr
Create Architecture Decision Records (ADRs) following project standards. Guides template usage, process, and best practices for documenting architecturally significant decisions.
Also in 5 projects that use this
OpenAISkillobservability
Vercel Observability expert guidance — Drains (logs, traces, speed insights, web analytics), Web Analytics, Speed Insights, runtime logs, custom events, OpenTelemetry integration, and monitoring dashboards. Use when instrumenting, debugging, or optimizing application performance and user experience on Vercel.
Also in 4 projects that use this
SentrySkille2e
Run E2E tests for Sentry JavaScript SDK test applications
Also in 3 projects that use this
OpenAISkillaudit
Audit or critique a product flow, journey, workflow, funnel, onboarding path, checkout path, settings path, screen, or multi-step product experience by capturing screenshots first, then reporting UX, design, and accessibility findings inline from that evidence. Use Figma only when the user explicitly asks for a board. Use when the user asks to audit, review, critique, inspect, assess, analyze, evaluate, or give feedback on a product experience.
Also in 4 projects that use this
Other versions25 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 25
- anthropics/knowledge-work-plugins★ 36ksame name
- suboss87/FDEOps★ 940same name
- sd0xdev/sd0x-dev-flow★ 192same name
- sd0xdev/sd0x-harness★ 192same name
- AsiaOstrich/universal-dev-standards★ 84same name
- NotHarshhaa/devops-skills★ 8same name
- AsiaOstrich/EngramGraph★ 4same name
- Firzus/agent-skills★ 4same name
- jocarrd/crux-agents★ 4same name
- gmanch94/claude-code-aidlc-template★ 2same name
15 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository13 other files it gives its agents.
- architecture-diagramSkill
- cloudflare-oneSkill
- cloudflareSkill
- containersSkill
- dashmotionSkill
- diagramSkill
- expose-a-service-safelySkill
- fix-and-deploySkill
- getting-startedSkill
- homelab-health-checkSkill
- homelab-troubleshootingSkill
- network-diagramSkill
- systematic-debuggingSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 7 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 22 edited versions we read keep these.
7
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 15
Ask only for what the user did not give:
- Distinctive: line 31
If a call returns no match, write the gap into the runbook as a line to fill in.
- Very specific: line 35
Create Runbooks/ in the current directory if it does not exist.
- Distinctive: line 37
If the file exists, show the user the path and ask before overwriting.
- Distinctive: line 38
Write the file with the template below.
- Distinctive: line 124
Write every procedure step as the Homelab tool call it uses, with its arguments.
- Distinctive: line 125
Put the expected result beside each step.
- Distinctive: line 127
Keep the file to the sections above.
“Common” is measured: kept by at least 6 in 10 of the 22 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Write a runbook for one service
This skill writes Runbooks/runbook-<slug>.md in the current working directory. It reads live facts from Homelab first, so the commands and names in the runbook match the running system.
1. Collect the inputs
Ask only for what the user did not give:
- Service name (required). Use the name the user uses, for example "Nginx Proxy Manager". Keep it unslugified in the frontmatter.
- One-line summary (required). One sentence that says what the service does.
- Owner (optional). Use
TBDwhen the user skips it.
2. Pull the facts (read only)
These calls change nothing.
docker_containerswithactionset togeton the container. Record the image, the state and the published ports.docker_containerswithactionset tologsand 50 lines. Use the output for the troubleshooting section.proxy_hostswithactionset tolist. Find the host whose domain names the service. Record the domain, the forward host, the forward port and whether SSL is on.dns_recordswithactionset tolistfor the zone that holds the domain. Record the record name, type and target. Skip this step when thednsmodule is off, and write "DNS: not managed by Homelab" in the runbook.proxy_certificateswithactionset tolist. Record the expiry date for the domain.
If a call returns no match, write the gap into the runbook as a line to fill in. Do not invent a value.
3. Write the file
- Create
Runbooks/in the current directory if it does not exist. - Slugify the service name: lowercase, spaces and symbols become hyphens, no leading or trailing hyphens. "Nginx Proxy Manager" becomes
runbook-nginx-proxy-manager.md. - If the file exists, show the user the path and ask before overwriting.
- Write the file with the template below. Replace each placeholder with a fact from step 2 or the user's answer.
- Report the path as a Markdown link. Do not open the file.
Template
---
tags: [runbook]
created: <YYYY-MM-DD>
updated: <YYYY-MM-DD>
status: draft
service: <service name>
owner: <owner>
last_verified: <YYYY-MM-DD>
review_cadence: quarterly
---
# Runbook: <service name>
## Overview
<one-line summary>
**Use this runbook when:**
- <situation that starts this procedure>
## Facts
| Item | Value |
|---|---|
| Container | <name>, image <image>, state <state> |
| Public name | <domain>, SSL <on or off>, certificate expires <date> |
| Forward target | <forward host>:<forward port> |
| DNS record | <record name> <type> <target>, or "not managed by Homelab" |
## Prerequisites
| Requirement | Details |
|---|---|
| Homelab tools | `docker` module on; `proxy` module on; `dns` module on if the DNS row is used |
| Secrets | Name each secret and its setting, such as `HOMELAB_PROXY_PASSWORD` or `HOMELAB_PROXY_PASSWORD_FILE`. Never the value. |
## Procedure
### Step 1: <title>
**Action:** `docker_containers` with `action` set to `<action>`, container `<name>`.
**Expected result:** <what the tool returns when the step works>
**Verify:** <the check that confirms the step>
Repeat for each step. Every change step starts with `dry_run` set to `true` and ends with the approved call.
## Rollback
Undo the steps in reverse order.
1. <undo step for step 2>
2. <undo step for step 1>
## Troubleshooting
### <symptom 1>
- **Symptom:** <what the user sees>
- **Cause:** <why it happens>
- **Fix:** <the exact tool call or host command>
## Escalation
| Order | Who | How | When |
|---|---|---|---|
| 1 | <owner> | <channel> | <threshold> |
Include the runbook path, the exact error text, and the time the failure started.
## Change log
| Date | Author | Change |
|---|---|---|
| <YYYY-MM-DD> | <author> | Initial draft |Rules for the content
- Write every procedure step as the Homelab tool call it uses, with its arguments.
- Put the expected result beside each step. A step without an expected result is not finished.
- Name the setting for each secret. Never write a secret value into the file.
- Keep the file to the sections above. Remove a section that has no content, and say so in the report.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

