# 🛡️ DocGuard [English](README.md) · [Português (BR)](README.pt-BR.md) · **Español** > **La capa de enforcement para Spec-Driven Development.** > Valida. Puntúa. Garantiza. Entrega documentación que los agentes de IA realmente pueden usar. [](https://github.com/raccioly/docguard/actions/workflows/ci.yml) [](https://www.npmjs.com/package/docguard-cli) [](https://pypi.org/project/docguard-cli/) [](https://opensource.org/licenses/MIT) --- > **✨ Mira lo que DocGuard detecta en 30 segundos — sin instalar nada:** > ```bash > npx docguard-cli demo > ``` ## ¿Qué es DocGuard? DocGuard es la herramienta de enforcement del **Canonical-Driven Development (CDD)**: una metodología donde la documentación es la fuente de la verdad y la herramienta **verifica, de forma determinista, que siga siendo verdad respecto al código**. La diferencia frente a otras herramientas de documentación: un resultado verde de DocGuard significa *"los documentos coinciden con el código, de forma verificable"* — no solo "los archivos existen". Extrae rutas, esquemas, variables de entorno, conteos y afirmaciones documentadas, y los compara contra el código real. Núcleo sin llamadas a LLM: determinista, offline, auditable. ## Inicio rápido ```bash # en el directorio de tu proyecto npx docguard-cli init # crea los documentos canónicos (detecta tu stack) npx docguard-cli guard # valida — verde significa "docs correctos" npx docguard-cli score # nota de madurez de la documentación (0-100) ``` Para un proyecto existente, el camino inverso funciona mejor: ```bash npx docguard-cli generate --plan --write # ingeniería inversa: docs desde el código ``` ## Los 5 comandos del día a día | Comando | Qué hace | |:--------|:---------| | `init` | Inicializa el proyecto (detecta el stack automáticamente) | | `guard` | Valida los documentos contra el código — la puerta de CI | | `diff` | Muestra las brechas entre docs y código (`--since ` para impacto de PR) | | `sync` | Regenera las secciones de "verdad del código" en los documentos | | `score` | Nota de madurez CDD, con desglose por categoría | La lista completa de comandos, validadores y flags está en el [README en inglés](README.md#usage) — el propio DocGuard la mantiene sincronizada con el código. ## Integración con IA (nativa, no improvisada) DocGuard está diseñado para ser usado **por** agentes de IA, no solo por humanos: - **Servidor MCP** — `claude mcp add docguard -- npx docguard-cli mcp` expone guard/score/explain/verify/diagnose como herramientas nativas para Claude, Cursor y cualquier cliente MCP. - **Contrato JSON estable** — `guard --format json` con códigos de hallazgo estables, explicables (`docguard explain `) y suprimibles en línea. - **SARIF** — `guard --format sarif` se integra con GitHub Code Scanning. - **llms.txt / llms-full.txt / context pack** — superficies de contexto para LLMs que leen el repositorio. - **GitHub Action** — anotaciones inline en el diff del PR + comentario fijo con el impacto en los documentos canónicos. - **`agents --sync`** — AGENTS.md se convierte en la fuente canónica de CLAUDE.md, las reglas de Cursor, las instrucciones de Copilot y demás — sin duplicación manual, sin drift. Guía completa: [docs/ai-integration.md](docs/ai-integration.md) (en inglés). ## Instalación permanente ```bash npm install -g docguard-cli # Node.js 18+ # o vía Python: pip install docguard-cli # wrapper de PyPI (requiere Node.js 18+) ``` ## Comunidad - [Discusiones](https://github.com/raccioly/docguard/discussions) — preguntas e ideas - [Issues](https://github.com/raccioly/docguard/issues) — bugs y peticiones de features - [CHANGELOG](CHANGELOG.md) — historial completo de versiones - [Cómo contribuir](CONTRIBUTING.md) --- **Licencia MIT** · Hecho para equipos que tratan la documentación como un contrato, no como un adorno.