Instalación y empaquetado

Esta guía describe cómo instalar la Atlantyqa Universe en tu máquina y cómo generar un paquete Debian (.deb) para desplegar la suite en entornos basados en Ubuntu o Debian. Las instrucciones aquí complementan el README del proyecto y forman parte de la documentación que se publica en GitHub Pages.

Instalación en modo desarrollo

Para ejecutar la suite en modo desarrollo sin contenedores ni paquetes precompilados sigue estos pasos en tu equipo:

1. Clona o descarga el repositorio de la suite.
2. Asegúrate de tener instalado Python 3.8 o superior y pip.
3. Ejecuta python cogctl.py init para crear las carpetas necesarias bajo data/ y outputs/.
4. Copia los archivos que quieras analizar en data/input/.
5. Ejecuta python cogctl.py ingest <ruta/al/archivo> para convertir el documento a texto.
6. Lanza el análisis con python cogctl.py analyze. Los resultados se almacenarán en outputs/insights/analysis.json.

Generación de paquete Debian

La suite incluye un script de apoyo para empaquetar todos los componentes en un archivo .deb. Esto facilita su distribución e instalación en equipos de desarrollo donde no se quiera usar Docker. El script se encuentra en scripts/build-deb.sh.

Construcción

1. Asegúrate de tener las herramientas de empaquetado instaladas. En sistemas basados en Debian o Ubuntu se instalan con sudo apt install dpkg-dev.
2. Ejecuta el script con la versión que deseas asignar al paquete, por ejemplo:

./scripts/build-deb.sh 0.1.0

El script crea un árbol temporal bajo tmp/, copia los archivos de la suite a /usr/local/lib/atlantyqa-universe, genera un wrapper ejecutable cogctl en /usr/local/bin y construye el paquete en el directorio dist/ con el nombre atlantyqa-universe_<versión>_all.deb.

Instalación

Para instalar el paquete generado en tu máquina:

sudo apt install ./dist/atlantyqa-universe_0.1.0_all.deb

Esto instalará la suite bajo /usr/local/lib/atlantyqa-universe y registrará cogctl en el PATH del sistema. Podrás ejecutar la CLI con cogctl desde cualquier directorio. Para desinstalarla, utiliza sudo apt remove atlantyqa-universe.

Publicación en GitHub Pages

El contenido público de la carpeta docs/ se publica automáticamente como un sitio estático mediante GitHub Pages usando el perfil mkdocs.public.yml (sin contenido docs/internal/**). El flujo de trabajo definido en .github/workflows/pages.yml se ejecuta cada vez que se actualizan los archivos de documentación. Una vez desplegado, podrás navegar el sitio en https://<usuario>.github.io/<repositorio>/ y consultar las guías y diagramas de uso externo.

La documentación interna (playbooks, revisiones de acceso y evidencias) se mantiene fuera de la publicación pública y se valida en CI como artefacto independiente.