Documentación

Todos los comandos, en un solo lugar.

Sintaxis, flags y ejemplos reales para cada comando de DataForge CLI.

Free

Comandos base

scan

dataforge scan [ruta]

Recorre recursivamente el proyecto, extrae el contexto de código y consulta al motor de IA activo para generar un reporte integral de arquitectura, riesgos y sugerencias. Se guarda en Markdown dentro de dataforge-reports/.

explain

dataforge explain [archivo]

Explica en detalle qué hace un archivo específico: propósito, estructura y decisiones de diseño probables.

map

dataforge map [ruta]

Genera un mapa ASCII de la arquitectura del repositorio: cómo se conectan los módulos entre sí.

ask

dataforge ask [ruta]

Abre un chat interactivo con el contexto completo del proyecto cargado. Escribe salir para terminar la sesión.

onboard

dataforge onboard [ruta]

Genera una guía de onboarding: resumen del proyecto, punto de entrada, archivos críticos y primeros pasos.

welcome

dataforge welcome

Abre la carta de bienvenida de DataForge CLI en el navegador.

setup

dataforge setup

Asistente interactivo para configurar o reconfigurar tu instalación: proveedor de IA, API key, idioma (es/en) y tema visual.

  • Free — proveedor fijo en Groq + idioma + tema por defecto
  • Pro — desbloquea los temas: Dark, Light, Tokyo Night, Dracula
  • Teams — desbloquea selector de proveedor: OpenAI, Gemini, Claude, Ollama

Si no hay licencia activa para una opción, setup la oculta en vez de mostrarla deshabilitada — nunca regala funciones de pago.

Pro

Comandos avanzados

doc++

dataforge doc++ [ruta]

Genera documentación de nivel producción: README, DOCUMENTATION.md, guía técnica, instalación, arquitectura y dependencias.

architecture++

dataforge architecture++ [ruta]

Genera diagramas Mermaid completos de relaciones entre carpetas, dependencias y flujo interno del proyecto.

explain (audiencia)

dataforge explain [archivo] --junior
  • --junior — explicación paso a paso, sin dar nada por sabido
  • --senior — directo al punto, enfocado en decisiones de diseño
  • --teacher — pensado para enseñar el concepto, no solo el código
  • --manager — enfocado en impacto y riesgo, sin jerga técnica

export++

dataforge export [ruta] --md
  • --md — Markdown
  • --txt — texto plano
  • --json — estructurado, para integrarlo a otra herramienta
  • --html — listo para compartir en el navegador

preset

dataforge preset onboarding

Ejecuta automáticamente Scan → Explain → Map → Documentation++ → Architecture++ → Export, en un solo paso.

license

dataforge license DFORGE-PRO-XXXX-XXXXX

Activa tu licencia PRO o Teams localmente. Usa dataforge license status para ver el plan y vencimiento actuales.

Teams

Configuración de equipo

Team Branding

Personaliza la firma que aparece en toda la documentación generada, para que salga con la identidad de tu estudio o cliente en vez de la de DataForge.

Enterprise AI — multi-proveedor

Cada integrante del equipo puede usar su propia API key. El enrutamiento ya está implementado en el CLI; dataforge setup lo desbloquea solo con licencia Teams activa.

  • Groq — velocidad pura para scan y ask
  • Claude — prosa técnica y arquitectura elegante
  • OpenAI — precisión lógica estricta
  • Gemini — análisis masivo de contexto
  • Ollama — motor local, 100% offline

Team Presets

El administrador del equipo define presets compartidos (por ejemplo: Architecture → Documentation → Export HTML) para que todos sigan el mismo flujo.

Shared Configuration

Temas, prompts y presets se comparten entre todo el equipo para mantener consistencia en la documentación de todos los proyectos.

Guías

Tutoriales paso a paso

Más allá del "qué hace cada comando": cómo sacarle el máximo provecho a DataForge en tu día a día.

De cero a tu primer reporte

El camino completo: instalar, configurar tu API key y correr tu primer scan.

  1. Instala con el método de 1 clic
  2. Corre python main.py y sigue el asistente
  3. dataforge scan . en un proyecto real
  4. Abre el reporte en dataforge-reports/

Cómo leer un reporte de scan

Un reporte de scan tiene tres bloques: arquitectura detectada, riesgos encontrados y sugerencias accionables.

  • Arquitectura — cómo está organizado el proyecto, en tus propias palabras generadas por IA
  • Riesgos — cosas concretas que revisar (falta de validación, timeouts, acoplamiento)
  • Sugerencias — próximos pasos priorizados, no una lista genérica

Sacarle más partido a ask

El chat consultor funciona mejor si le das contexto de intención, no solo preguntas sueltas.

  • Empieza contando qué vas a hacer ("voy a refactorizar el módulo de pagos")
  • Pide comparaciones concretas ("¿A o B, y por qué?") en vez de "¿qué opinas?"
  • Usa salir y vuelve a abrir ask si cambias de tema — mantiene el contexto enfocado

Elegir el flag correcto de explain

La misma pregunta, cuatro respuestas distintas según quién la necesita.

  • --junior — te estás incorporando al proyecto
  • --senior — vas a tomar una decisión de diseño
  • --teacher — le vas a enseñar el concepto a alguien más
  • --manager — vas a justificar tiempo o riesgo ante alguien no técnico

Armar tu propio preset

Si repites la misma secuencia de comandos seguido, un preset te la deja en un solo paso.

  1. Identifica tu flujo recurrente (ej. scan → doc++ → export)
  2. Actívalo con dataforge preset onboarding como punto de partida
  3. En Teams, compártelo con todo el equipo vía Team Presets

Activar y verificar tu licencia

Después de tu compra, dos comandos son todo lo que necesitas.

  1. dataforge license DFORGE-PRO-XXXX-XXXXX
  2. dataforge license status para confirmar plan y vencimiento
  3. Corre dataforge setup para desbloquear temas/proveedores según tu plan
Solución de problemas

Errores comunes y cómo resolverlos

Lo que más reportan los usuarios de Early Access, con la causa probable y la solución.

Causa probable: sin conexión a internet, o un firewall/proxy corporativo bloqueando GitHub.

Verifica tu conexión y que puedas abrir github.com en el navegador desde la misma red. Si estás en una red corporativa, prueba el método Git clone o ZIP en su lugar — a veces esos sí pasan por el proxy configurado de git.

Causa probable: Python no está en el PATH del sistema.

Reinstala Python desde python.org marcando la casilla "Add python.exe to PATH" durante la instalación. Si ya lo instalaste sin esa opción, prueba con py en vez de python — el launcher de Windows suele estar disponible aunque el PATH no lo esté.

Causa probable: las dependencias no se instalaron, o se instalaron en otro entorno de Python.

Desde la carpeta dataforge-cli, corre pip install -r requirements.txt. Si tienes varias versiones de Python instaladas, usa python -m pip install -r requirements.txt para asegurarte de instalar en el mismo intérprete con el que vas a correr el CLI.

Causa probable: la ruta apunta a una carpeta vacía, o a una carpeta fuera del proyecto (como una carpeta de sistema).

Confirma la ruta con dataforge scan . parado dentro de la carpeta del proyecto, en vez de pasar una ruta absoluta que podría estar mal escrita. Si el proyecto es válido y sigue sin encontrar nada, revisa que no esté completamente vacío o que los archivos no tengan una extensión no reconocida.

Causa probable: proyecto muy grande (mucho contexto a procesar), o límite de rate en tu API key.

Prueba escaneando una subcarpeta específica en vez de la raíz completa de un repo enorme. Si tu proveedor te devuelve un error de rate limit, espera unos segundos e intenta de nuevo — cada proveedor (Groq, OpenAI, etc.) tiene sus propios límites según tu plan de API, independientes de tu licencia de DataForge.

Causa probable: el código se copió con espacios extra, o no coincide el formato exacto.

El formato debe ser exactamente DFORGE-PRO-XXXX-XXXXX (o TEAMS/ENT según tu plan), sin espacios al inicio o final. Corre dataforge license status para confirmar qué quedó guardado. Si el problema persiste, abre un Issue con el mensaje de error exacto (nunca compartas tu código de licencia completo en un Issue público).

¿Falta algo en la documentación?