Open source · Performance & Reliability

Runbook Link Checker

Check runbook links, owners, prerequisites and stale steps.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Audit exported Markdown runbooks for local links, anchors, prerequisite targets and owner review age. An optional status export supplies dated evidence for external links. The checker never fetches a URL, resolves a host, opens a socket, or changes a runbook. It reports what the supplied files establish, including what they do not establish.

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

node bin/runbook-link-checker.mjs --root examples --manifest clean.manifest.json --as-of 2026-09-20 --json
node bin/runbook-link-checker.mjs --root examples --manifest broken.manifest.json --as-of 2026-09-20
node bin/runbook-link-checker.mjs --root examples --manifest incomplete.manifest.json --as-of 2026-09-20 --json
node bin/runbook-link-checker.mjs --root examples --manifest incomplete.manifest.json --snapshots snapshots.json --as-of 2026-09-20 --json

Read the result

The clean example exits 0; the broken anchor/stale owner example exits 1; the external-link example without its snapshot exits 2 with an incomplete report. Supplying the included capture makes that last example pass as captured, not live. npm run check runs syntax, tests and the clean example.

Where this check stops

JSON duplicate keys, unsafe numeric rounding, undecodable UTF-8, over-depth input and unsupported input are not silently simplified. Missing, out-of-root or unreadable runbooks and local targets never turn into evidence of absence. Every report string is bounded and single-line; untrusted Markdown labels and external URL query values are not emitted.

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.