DocPro - Documentador con IA

Herramienta CLI que analiza código fuente y genera documentación técnica usando GPT, con interfaz web interactiva y chat.

Instalación

# Instalar globalmente
npm install -g docpro-ai

# O usar directamente con npx
npx docpro-ai analyze --path ./mi-proyecto

Configuración

Configura tu API key de OpenAI:

Linux/macOS:

export OPENAI_API_KEY="tu-api-key-aqui"

Windows (CMD):

set OPENAI_API_KEY=tu-api-key-aqui

Windows (PowerShell):

$env:OPENAI_API_KEY="tu-api-key-aqui"

Archivo .env (recomendado): Crea un archivo .env en tu proyecto:

OPENAI_API_KEY=tu-api-key-aqui

Uso

Analizar cualquier proyecto

docpro analyze --path ./mi-proyecto

Opciones disponibles

docpro analyze [opciones]

Opciones:
  -p, --path <path>     Ruta a analizar (default: directorio actual)
  -o, --output <dir>    Directorio de salida (default: ./docs)
  --port <puerto>       Puerto del servidor (default: 3000)

Soporte universal

DocPro analiza automáticamente cualquier tipo de archivo de código fuente, sin restricciones de lenguaje. La IA se adapta al contenido y genera documentación apropiada para:

• Cualquier lenguaje de programación
• Archivos de configuración
• Scripts y automatizaciones
• Documentación existente
• Y mucho más

Características

• ✅ Análisis automático de código
• ✅ Documentación técnica generada con GPT
• ✅ Interfaz web moderna
• ✅ Chat interactivo con conocimiento del proyecto
• ✅ Base de datos SQLite para persistencia
• ✅ Búsqueda en tiempo real
• ✅ Resaltado de sintaxis

Desarrollo

# Instalar dependencias
npm install

# Ejecutar en modo desarrollo
npm run dev

Estructura del proyecto

docpro/
├── bin/docpro.js          # CLI ejecutable
├── src/
│   ├── DocPro.js          # Clase principal
│   ├── CodeAnalyzer.js    # Analizador de archivos
│   ├── Database.js        # Manejo de SQLite
│   └── Server.js          # Servidor Express + Socket.IO
├── public/
│   ├── index.html         # Interfaz web
│   └── app.js            # JavaScript frontend
└── package.json