Open source · Docs & Knowledge

Runbook Step Linter

Lint runbook steps for commands, prerequisites, expected output and rollback.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Lint runbook steps for the five things a person woken at 03:00 actually needs: a named owner, stated prerequisites, an expected output that makes success checkable, a recovery path for when it fails, and command boundaries that leave no doubt where a command starts and ends.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+; inspect the source before using it on your own files.

Run the checked-in example

npm install github:edilec/runbook-step-linter

Read the result

This installs the public GitHub source; runbook-step-linter is not published to npm.

Where this check stops

Markdown support is deliberately narrow: ATX headings, fenced blocks with backticks or tildes, list markers, blockquote markers and inline code spans. HTML blocks, setext headings, reference definitions and indented code blocks are read as ordinary text.

Before adapting the command to your own workflow, review the accepted inputs, exit codes and safety boundaries in the README.

Compiled with AI assistance from checked-in public documentation and example scripts. Run the example and review the repository's current documentation before relying on its result.