Is your documentation lying to your team?
Documentation Drift is the silent killer of developer velocity. @ordomesh/drift-check is a zero-auth, local CLI that quantifies exactly how far your docs have fallen behind your code.
Get started in seconds
npx @ordomesh/drift-check ./your-repoRuns in seconds. No data leaves your machine. Supports Markdown and RST.
A lightweight alternative to manual documentation audits and broken link checkers.
How the drift score works
For every source file changed in the last 6 months, drift-check finds the nearest documentation file and computes:
- commit_count — number of commits to the code file in the last 6 months.
- days_since_doc_update — days since the paired doc was last touched. If no doc exists, 730 days (2 years) is assumed.
Files with zero commits are excluded — only actively changing code contributes to drift.
For a file like src/auth/login.ts, drift-check searches for documentation in this order:
Pass --docs "**/docs/*.md" to restrict which files count as documentation.
Why it's more than a script
Zero-Configuration
No API keys, no sign-up. Point it at any git repository and run. Works immediately.
Format Agnostic
Handles standard Markdown and Sphinx-compatible RST out of the box. No extra plugins.
CI/CD Ready
Exit codes designed for automation. Pipe --markdown output directly to $GITHUB_STEP_SUMMARY.
Privacy First
MIT licensed and 100% local. Your code and documentation never leave your machine.
Seeing numbers is one thing.
Seeing the structure is another. Once you have your drift scores, map the full shape of your documentation chaos — or let OrdoMesh keep things in sync automatically.