agent-doc-generator

Genera documentación JSDoc automática usando IA.

Instalación

# Global
npm install -g agent-doc-generator

# O sin instalar
npx agent-doc-generator --path ./src

Uso

agent-doc-generator --path ./src                        # documentación de todo src/
agent-doc-generator --path ./src/utils.ts               # un solo archivo
agent-doc-generator --path ./src --split                # un DOCS.md por archivo
agent-doc-generator --path ./src --format html          # salida HTML
agent-doc-generator --path ./src --extensions .ts,.prisma  # solo archivos .ts y .prisma
agent-doc-generator --path ./src --dry-run              # preview sin escribir
agent-doc-generator --path ./src --verbose              # logs detallados

Proveedores

| Provider | Modelo Default | Auth | Notas | |----------|---------------|------|-------| | gemini | gemini-2.5-flash | GEMINI_API_KEY | Free tier disponible | | openai | gpt-4o | OPENAI_API_KEY | GPT-4o, GPT-4o-mini | | anthropic | claude-sonnet-4-20250514 | ANTHROPIC_API_KEY | Claude | | deepseek | deepseek-chat | DEEPSEEK_API_KEY | El más barato | | ollama | modelo instalado | Sin key | Local, gratis, privacidad |

Auto-detección: Si no especificas --provider, detecta automáticamente qué tienes configurado (keys en .env o Ollama corriendo).

Flags

| Flag | Descripción | Default | |------|-------------|---------| | --path | Archivo o carpeta a procesar | (requerido) | | --provider | gemini | openai | anthropic | deepseek | ollama | auto-detectado | | --model | Modelo a usar | según provider | | --base-url | URL del servidor (Ollama) | http://localhost:11434 | | --api-key | API key (opcional para Ollama) | .env | | --max-chars | Límite de chars por archivo | 15000 | | --output | Carpeta/archivo de salida | junto al archivo | | --extensions | Extensiones a procesar (CSV: .ts,.prisma) | todas | | --split | Un archivo por cada fuente | false | | --format | Formato de salida terminal | markdown | html | pdf | terminal | | --dry-run | Solo preview, no escribir | false | | --verbose | Logs detallados | false |

Features

• Modo single (default): genera un único DOCS.md
• Modo split (--split): genera .docs.md por cada fuente
• Cache: hash MD5 para no regenerar archivos sin cambios
• Auto-detección: detecta provider disponible al iniciar
• Resiliencia: 3 reintentos con backoff ante errores de API
• Truncado: archivos > --max-chars se recortan con aviso
• Filtro por extensión: --extensions .ts,.prisma para limitar tipos de archivo

Requisitos

• Node.js >= 18
• Un proveedor de IA configurado (API key o Ollama local)

Licencia

MIT

Parte de AI Agent Toolkit.