DocCov

Documentation coverage and drift detection for TypeScript.

Install

npm install -g @doccov/cli

Usage

# Generate spec (outputs to .doccov/{package}/)
doccov spec

# Check coverage (fail if below 80%)
doccov check --min-coverage 80

# Auto-fix drift issues
doccov check --fix

Badges

Add a documentation health badge:

![Docs](https://api.doccov.com/badge/YOUR_ORG/YOUR_REPO?path=.doccov/your-package/doccov.json)

For scoped packages:

![Docs](https://api.doccov.com/badge/YOUR_ORG/YOUR_REPO?path=.doccov/@your-org/pkg/doccov.json)

Requires .doccov/{package}/doccov.json committed to your default branch. See badge docs for options.

Documentation

Full documentation at docs/README.md:

• Getting Started
• CLI Reference
• API Reference
• SDK Reference

Packages

Package	Purpose
@doccov/spec	DocCov spec schema, validation
@doccov/sdk	Core SDK
@doccov/cli	CLI tool

Dependencies (external)

Package	Purpose
@openpkg-ts/spec	OpenPkg spec schema, validation, diff
@openpkg-ts/extract	TS export extraction
@openpkg-ts/doc-generator	API doc generator
@openpkg-ts/fumadocs-adapter	Fumadocs integration
@openpkg-ts/ui	Docs UI components

License

MIT