DocGuard
DocGuard reads what your documentation claims about your code, reads the code, and reports every claim the two no longer agree on. Each finding says how sure it is and whether it is a fix the tool can name or a judgement it hands to you. It runs offline, makes no model or network calls at validation time, and works with any coding agent.
npx docguard-cli demo
The demo runs against a sample project and needs no install or setup.
Start here
| If you want to | Read |
|---|---|
| Try it on a new project in five minutes | Quick Start |
| Install it as a CLI, Python package, Homebrew formula, container, Action or Spec Kit extension | Installation |
| Adopt it on a repository that already has code | Existing Projects |
| Use it with GitHub Spec Kit | Spec Kit |
| Gate pull requests | Continuous Integration |
| Know which languages and frameworks it reads | Languages and Frameworks |
| Connect your coding agent | Coding Agents and AI Integration |
| Understand a finding code | Finding Codes |
Guides
- Existing Projects: from a clean branch to a gated first pull request.
- Spec Kit: the extension, its hooks and the spec lifecycle registry.
- Continuous Integration: GitHub Actions and other CI systems.
- Monorepos: several packages in one repository.
- Upgrading: moving between versions safely.
- Troubleshooting: exit codes, false positives and partial coverage.
- AI Integration and Compliance Profiles.
Reference
- Commands and Configuration.
- Languages and Frameworks, Coding Agents and the MCP Server.
- Finding Codes, generated from the code that reports them.
- FAQ.
- Section-Addressable Docs: the markers that separate code-derived sections from your prose.
Background
- The technical brief (PDF) explains the method, the research behind the detectors and how their numbers are measured.
- Philosophy, the CDD Standard and Comparisons live in the repository.
Other languages
These guides are in English. A short introduction is available in Spanish and Portuguese (Brazil).