Documentación de intake

De requisitos en cualquier formato a implementación verificada.

intake es una herramienta CLI open-source que transforma requisitos desde múltiples fuentes y formatos (Jira, Confluence, PDFs, Markdown, YAML, imágenes, DOCX, texto libre) en una especificación normalizada y verificable que cualquier agente de IA puede consumir.

intake = Requisitos caóticos (N fuentes, N formatos) -> Spec ejecutable -> Cualquier agente IA

Requisitos previos

  • Python 3.12+
  • API key de un proveedor LLM (Anthropic, OpenAI, Google, etc.)

Instalación

pip install intake-ai-cli

El comando CLI se llama intake:

intake --version
intake doctor

Para desarrollo local:

git clone https://github.com/your-org/intake-cli.git
cd intake-cli
pip install -e ".[dev]"

Guías

DocumentoDescripción
ArquitecturaArquitectura del sistema, módulos, flujo de datos y decisiones de diseño
Guía CLIReferencia completa de los 8 comandos con todas sus opciones
ConfiguraciónTodas las opciones de .intake.yaml, presets y variables de entorno
PipelineCómo funciona el pipeline de 5 fases en detalle
Formatos de entradaLos 8 parsers soportados, qué extraen y cómo se auto-detectan
VerificaciónMotor de checks de aceptación, reporters y CI/CD
ExportaciónFormatos de exportación para agentes IA
Buenas prácticasTips, patrones recomendados y cómo sacar el máximo provecho
Solución de problemasErrores comunes, diagnóstico y FAQ

Inicio rápido

# 1. Verificar que el entorno está listo
intake doctor

# 2. Generar una spec desde un archivo Markdown
intake init "Sistema de autenticación OAuth2" -s requirements.md

# 3. Generar desde múltiples fuentes
intake init "Pasarela de pagos" -s jira.json -s confluence.html -s notas.md

# 4. Verificar la implementación contra la spec
intake verify specs/pasarela-de-pagos/ -p .

# 5. Exportar para un agente específico
intake export specs/pasarela-de-pagos/ -f architect -o output/

Los 6 archivos spec

Cada spec generada contiene:

ArchivoPropósito
requirements.mdQué construir. Requisitos funcionales y no funcionales.
design.mdCómo construirlo. Arquitectura, interfaces, decisiones técnicas.
tasks.mdEn qué orden. Tareas atómicas con dependencias.
acceptance.yamlCómo verificar. Checks ejecutables: comandos, patrones, archivos.
context.mdContexto del proyecto para el agente: stack, convenciones, estado.
sources.mdTrazabilidad completa: cada requisito mapeado a su fuente original.

Además se genera spec.lock.yaml para reproducibilidad (hashes de fuentes, costos, timestamps).