skillsaw-runbooks
A skillsaw plugin that lints operational runbooks as agent content. Runbooks are step-by-step procedures executed under pressure — increasingly by AI agents as well as on-call engineers — so they deserve the same lint coverage as any other instruction file.
This plugin also serves as a complete, published example of every skillsaw plugin extension point: rules, a custom repository type with content paths, a lint tree contributor, and a plugin CLI.
What it does
When a repository has markdown files under runbooks/, the plugin:
- detects the
runbookrepository type, which activates the rules below and pullsrunbooks/**/*.mdinto skillsaw's content linting (so every builtincontent-*rule covers your runbooks too); - attaches
runbooks/catalog.json(if present) to the lint tree so the catalog rule can check it.
Rules
| Rule | Default severity | Checks |
|---|---|---|
runbook-required-sections |
warning | Every runbook has the required headings (default: Steps, Rollback) |
runbook-frontmatter |
warning | Every runbook has YAML frontmatter with the required fields (default: title, owner) |
runbook-catalog |
warning | runbooks/catalog.json, when present, lists every runbook and only runbooks that exist |
A passing runbook:
---
title: Database failover to the replica
owner: storage-team
---
# Database failover
## Steps
1. Freeze writes ...
## Rollback
Repeat with the old primary as the candidate ...
A failing one — no owner, no Rollback section:
---
title: Flush the Redis cache
---
# Cache flush
## Steps
1. redis-cli --scan --pattern 'rates:*' | xargs redis-cli del
$ skillsaw lint
⚠ WARNING (runbook-required-sections) [runbooks/cache-flush.md]: Runbook is missing a 'Rollback' section
⚠ WARNING (runbook-frontmatter) [runbooks/cache-flush.md]: Runbook frontmatter is missing 'owner'
Catalog
Optionally keep an index of your runbooks in runbooks/catalog.json:
{
"runbooks": [
"db-failover.md",
"cache-flush.md"
]
}
Paths are relative to runbooks/. The runbook-catalog rule warns when a
runbook on disk is missing from the catalog or a catalog entry has no
file. Without a catalog file the rule stays quiet — it is opt-in by
presence.
Install
$ pip install skillsaw-runbooks
$ skillsaw lint
That's it — skillsaw discovers the plugin automatically. Requires a skillsaw new enough to support plugins (>= 0.15).
CLI
The plugin ships a small companion CLI, dispatched through skillsaw:
$ skillsaw runbooks list
runbooks/db-failover.md: Database failover to the replica — storage-team
runbooks/cache-flush.md: Flush the Redis cache — (no owner)
$ skillsaw runbooks rules
runbook-required-sections — Runbooks must contain the required sections (default: Steps, Rollback)
...
Configuration
Configure rules by ID in .skillsaw.yaml, like any builtin rule:
rules:
runbook-required-sections:
severity: error
sections: ["Steps", "Rollback", "Verification"]
runbook-frontmatter:
fields: ["title", "owner", "last-reviewed"]
Disable a single rule, the whole plugin, or all plugins:
rules:
runbook-catalog:
enabled: false
plugins:
disable: [runbooks]
$ skillsaw lint --no-plugins
Development
$ python -m venv .venv
$ .venv/bin/pip install -e '.[dev]'
$ .venv/bin/pytest
To develop against an unreleased skillsaw, install it first:
.venv/bin/pip install -e ../skillsaw.
License
Apache-2.0
Metadata
Release files for skillsaw-runbooks 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| skillsaw_runbooks-0.1.0.tar.gz | 13.8 kB | With provenance | Details for skillsaw_runbooks-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| skillsaw_runbooks-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for skillsaw_runbooks-0.1.0-py3-none-any.whl |
Total release size: 26.0 kB
Release files / skillsaw_runbooks-0.1.0.tar.gz
| Download URL | skillsaw_runbooks-0.1.0.tar.gz |
|---|---|
| Size | 13.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c427057b11060dcadd5b0b63fbec1defb20e1b2e9e32cceb307736ba48caac69
|
|
BLAKE2b-256 checksum How to use checksums |
08ebb7b9ab004e2f6c68268e1ca34f20a507c0d791396e6609d8cb4cfa99d8df
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 2, 2026.
Transparency logRelease files / skillsaw_runbooks-0.1.0-py3-none-any.whl
| Download URL | skillsaw_runbooks-0.1.0-py3-none-any.whl |
|---|---|
| Size | 12.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
22be829cadd33329489fb469cc55eb98a76df1c5dbd466fe6ed9b88058d64295
|
|
BLAKE2b-256 checksum How to use checksums |
06e3b677923bccf883d97043df669003ea1d26cc94e67e0b44949ddb39bccc0b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 2, 2026.
Transparency logSecurity for skillsaw-runbooks 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for skillsaw_runbooks-0.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 2, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.