Skip to main content
Documentation

DocSutra AI

Check Markdown links, anchors, alt text, and leaked credentials offline.

Offline documentation auditor for Markdown. npm [email protected] published 2026-11-10. The README says it does not call the network and does not execute commands from Markdown.

  • Offline
  • 16 skills
  • Node 20+
GitHub version
0.2.1
Licence
Apache-2.0
Language
HTML
Weekly downloads
511
Overall downloads
511
GitHub stars
4

Live npm weekly downloads, npm overall downloads, and the latest npm version, plus GitHub stars and the package.json version, fetched 2026-11-17 19:07 UTC. Cached 10 minutes. Weekly downloads cover 2026-11-10 to 2026-11-16. Overall downloads cover 2026-10-01 to 2026-11-17. npm does not publish an earlier total. Stars and downloads show public use. They are not a quality score.

Use it when

  • 1

    You want broken local links and heading anchors found without fetching the web.

  • 2

    You want documented CLI flags checked against a contract you declare.

  • 3

    You want credentials in docs redacted in the report.

What it does, and what it does not

Read this before the guide. A limit here is a limit of the tool.

Does

  • Checks local links, GitHub-style heading anchors, path case, image alt text, empty link text, skipped heading levels, unclosed fences, and duplicate headings.
  • Flags documented subcommands or flags that are missing from a CLI contract you declare in docsutra.config.json.
  • Detects credentials in docs and redacts them in JSON, Markdown, and HTML, as the README states.
  • Flags curl | sh, destructive commands, and unsafe URL schemes. The README says those snippets are never executed.
  • 16 skills: 8 CLI-backed and 8 instructions only. The README says copying files is not verified host activation.
  • The README records 72 passed tests, 0 failed, and 3 skipped on Node 24 / Windows. Precision and recall on the author-written corpus are stated as 100% (18 of 18 planted issues). The README says that corpus is small and is not an accuracy claim for arbitrary repositories.

Does not

  • External URLs are never fetched. Shell lines are never executed. Symlinks are skipped.
  • A passing report means the supported static checks passed. The README says it does not prove the documentation is true.
  • Exit 0 is clean. Exit 1 is findings at or above --fail-on (default error). Exit 2 is usage, config, or runtime error.
  • Needs Node.js 20 or newer. 0 runtime dependencies, as stated in the README.

Claims above are from the project pages and are attributed as stated there. They are not independently verified here.

How a run moves

From the DocSutra AI README, npm 0.2.0, published 2026-11-10. It reads Markdown. It does not fetch URLs and does not run shell lines.

  1. 1. Input

    Markdown in the repo

    Links, headings, images, and documented commands. Symlinks are skipped.

  2. 2. Check

    Static rules

    Local links, anchors, alt text, CLI contracts you declare, and credential-shaped text. External URLs stay unfetched.

  3. 3. Report

    Three files

    .docsutra/audit.md, audit.html, and audit.json. SARIF is optional. Credentials are redacted in those copies.

  4. 4. Decision

    Exit 1 is a finding

    Default --fail-on is error. A clean exit is not proof the documentation is true.

How to read the result

Result It means It does not mean
A finding A supported static check failed, with file and line. External URLs were not opened. Shell snippets were not run.
Exit 0 Nothing at or above the fail threshold. Not proof the guide is accurate.
100% recall The README says 18 of 18 planted issues were found on its own corpus. The README says that corpus is small, author-written, and not an accuracy claim for arbitrary repositories.

Wording is from the project page or README and is attributed as stated there. It is not independently verified here.

Commands and notes

  • npx [email protected] scan --root . writes .docsutra/audit.md, audit.html, and audit.json.
  • docsutra scan --root . --format sarif --out docsutra.sarif
  • docsutra scan --root . --baseline main-audit.json gate on new findings.
  • docsutra diff --before old.json --after new.json
  • docsutra install-skills --host claude --target . also the other hosts named in the README.

Guide

How to use the result. GitHub is the source repository. npm is the install.

What the scan checks

From the DocSutra AI README, npm 0.2.0, published 2026-11-10. Offline. Node.js 20 or newer.

  • Local links, GitHub-style heading anchors, path case, image alt text, empty link text, skipped heading levels, unclosed fences, and duplicate headings.
  • Documented subcommands or flags missing from a CLI contract you declare in docsutra.config.json.
  • Credentials in docs are flagged and redacted in JSON, Markdown, and HTML. curl | sh, destructive commands, and unsafe URL schemes are flagged and never executed.
  • A finding lists file, line, rule, severity, and a fix. Reports: .docsutra/audit.md, audit.html, and audit.json. SARIF is a separate --format.

What a pass is not

  • External URLs are never fetched. Shell lines are never executed. Symlinks are skipped.
  • A passing report means the supported static checks passed. The README says it does not prove the documentation is true.
  • Exit 0 is clean. Exit 1 is findings at or above --fail-on (default error). Exit 2 is usage, config, or runtime error.
  • 16 skills: 8 CLI-backed and 8 instructions only. Copying files is not verified host activation.
  • The README records 72 passed, 0 failed, and 3 skipped on Node 24 / Windows. Precision and recall on the author-written corpus are stated as 100% (18 of 18). The README says that corpus is small and is not an accuracy claim for arbitrary repositories.

Questions

Does DocSutra open the links?

Local links and heading anchors, yes. The README says external URLs are never fetched and shell lines are never executed.

Does a passing audit mean the docs are true?

No. The README says a passing report means the supported static checks passed. It does not prove the documentation is true.

WhatsApp