Skip to content
andres20980Public

About

No description, website, or topics provided.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

94 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📖 openwiki - Agente Inteligente de Documentación

openwiki es una potente herramienta de línea de comandos (CLI) impulsada por agentes autónomos de IA (DeepAgents) diseñada para analizar, generar y mantener de forma totalmente automatizada la documentación de cualquier base de código.

Olvídate de la documentación obsoleta: openwiki escanea el repositorio, asimila su arquitectura y mantiene el Wiki de tu proyecto siempre actualizado y sincronizado con cada cambio del código fuente.


🎯 Descripción General

openwiki actúa como un redactor técnico virtual integrado directamente en tu flujo de trabajo de desarrollo. Utilizando agentes cognitivos avanzados basados en arquitecturas de grafos (LangGraph), el CLI es capaz de:

  • Comprender el contexto de tu código: Analiza lenguajes, frameworks, APIs y dependencias para estructurar la documentación de manera lógica.
  • Actualizaciones incrementales e inteligentes: Detecta qué partes de la base de código han cambiado para reescribir o complementar exclusivamente las secciones de la documentación afectadas.
  • Interfaz interactiva rica: Emplea una UI moderna directamente en tu terminal construida con React e Ink, facilitando la configuración, el diagnóstico y el seguimiento del estado del agente en tiempo real.
  • Automatización total en CI/CD: Se ejecuta de forma desasistida en pipelines de integración continua (como GitHub Actions o GitLab CI) para que la Wiki se actualice automáticamente con cada fusión a la rama principal.

🛠️ Tecnologías y Librerías Utilizadas

El núcleo del proyecto se asienta sobre las siguientes tecnologías y dependencias clave:

  • Entorno de Ejecución: Node.js (versión 20 o superior).
  • Lenguaje de Programación: TypeScript para un desarrollo robusto y tipado estricto.
  • Tecnología de Agentes de IA:
    • deepagents: Framework para la orquestación de agentes autónomos.
    • langchain & @langchain/core: Integración de flujos de trabajo con Modelos de Lenguaje de Gran Escala (LLMs).
    • @langchain/langgraph-checkpoint-sqlite: Persistencia del estado y memoria del agente de documentación en bases de datos SQLite locales.
    • Proveedores soportados: Anthropic (@langchain/anthropic), OpenAI (@langchain/openai) y OpenRouter (@langchain/openrouter).
  • Interfaz de Usuario de Terminal (CLI):
    • ink & react: Renderizado de componentes interactivos basados en React en la propia línea de comandos.
  • Pruebas unitarias y de integración: vitest con soporte para reporte de cobertura mediante @vitest/coverage-v8.

📁 Estructura de Carpetas

La arquitectura del proyecto está organizada de forma modular de la siguiente manera:

  • src/: Código fuente de la aplicación.
    • agent/: Lógica de inteligencia artificial. Define los prompts de sistema (prompt.ts), los esquemas de flujo del agente (index.ts), los tipos (types.ts) y utilidades operativas (utils.ts).
    • cli.tsx: Punto de entrada interactivo del CLI construido con Ink y React.
    • commands.ts: Definición de los comandos del CLI y las tareas de automatización de mantenimiento de wikis.
    • credentials.tsx & env.ts: Gestión, validación y almacenamiento seguro de credenciales y variables de entorno.
    • startup.ts: Orquestación y verificación inicial del sistema durante el arranque.
    • diagnostics.ts & fs-errors.ts: Manejo de errores y autodiagnósticos de lectura/escritura en el sistema de archivos del repositorio.
  • examples/: Flujos de trabajo listos para usar en tus pipelines de CI/CD.
    • openwiki-update.yml: Workflow para GitHub Actions.
    • openwiki-update.gitlab-ci.yml: Plantilla para GitLab CI.
  • scripts/: Utilidades y scripts bash de mantenimiento del entorno.
  • test/: Suite exhaustiva de pruebas unitarias utilizando Vitest, que valida la robustez de los comandos, la detección de errores y el procesado de prompts.

🚀 Instalación y Ejecución Local

Requisitos Previos

Asegúrate de tener instalados los siguientes componentes:

1. Clonar e Instalar Dependencias

Clona el repositorio e instala todas las dependencias del espacio de trabajo utilizando pnpm:

git clone <url-del-repositorio>
cd openwiki
pnpm install

2. Configurar Variables de Entorno

Copia el archivo de variables de entorno de ejemplo y configúralo con tus credenciales de IA correspondientes:

cp .env.example .env

Abre el archivo .env y define tu proveedor de IA preferido junto con su clave de API:

OPENAI_API_KEY=tu_openai_key
# o bien
ANTHROPIC_API_KEY=tu_anthropic_key
# o bien
OPENROUTER_API_KEY=tu_openrouter_key

3. Ejecución en Entorno de Desarrollo

Para ejecutar el CLI directamente en caliente sobre tu base de código sin necesidad de compilarlo previamente:

pnpm run dev

4. Compilación y Despliegue de Producción

Para compilar el proyecto a código JavaScript optimizado de Node.js:

# Limpia compilaciones anteriores y genera los artefactos en /dist
pnpm run build

# Ejecuta el CLI compilado en producción
pnpm run start

5. Suite de Pruebas

Para validar el correcto funcionamiento de todos los módulos y utilidades del agente:

# Ejecutar los tests con Vitest
pnpm test

# Obtener informe detallado de cobertura de código
pnpm run coverage

⚙️ Gobernanza del Proyecto

Este repositorio cuenta con rigurosos controles de calidad automatizados para garantizar la estabilidad del software antes de cada publicación:

  • Validaciones Pre-commit: Usamos Lefthook junto con Biome y Prettier para formatear, analizar la sintaxis y aplicar reglas de linteo de forma ultrarrápida antes de que el código sea confirmado en Git.
  • Auditoría de Seguridad: El script scripts/security_audit.sh permite ejecutar un análisis estático de dependencias y secretos locales a través de Bumblebee.
  • Protección del Repositorio: El archivo .no-mistakes.yaml actúa como puerta de enlace de validación, impidiendo la integración de código que no supere satisfactoriamente la batería de pruebas y checks de tipado.

Megacore - Automatizando y estandarizando la calidad del software en Megasoft.

About

No description, website, or topics provided.

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages