📝 idocs

CLI tool that detects when your markdown docs become stale relative to source files.

Track which source files your documentation references. When a source changes, idocs flags the doc as stale — re-hash after review to acknowledge it's up to date.

Download from Releases:

# requires Rust toolchain
cargo install --git https://github.com/gmars1/idocs

idocs init
idocs add auth src/auth.rs src/login.rs   # register doc
idocs                                      # check all
idocs -i                                   # TUI mode

idocs — check all docs, show valid/stale
idocs <file> — filter docs tracking a specific source file
idocs init — initialize .idocs directory
idocs add <name> <sources...> — register a doc tracking source files
idocs rm <name> — remove a doc
idocs info <name> — doc details with source status
idocs up <name> — re-hash sources after review
idocs stale — list only stale docs
idocs read <name> — print doc content
idocs edit <name> --set "..." — replace entire doc content
idocs edit <name> --lines N-M --text "..." — replace a range of lines
idocs edit <name> --replace "x" --with "y" — find-and-replace
idocs edit <name> --rehash — update source hashes after editing
idocs edit <name> (stdin pipe) — read new content from stdin
idocs -i — interactive TUI (two-panel viewer)
idocs --json — machine-readable output