Indexador de contexto enriquecido para optimización de RAG en LLMs con soporte Agentic Scaffolding, Auto-Sync, Trazabilidad y Persistencia tmux
Project description
RAG Context Indexer
Indexador de contexto enriquecido para optimización de RAG en LLMs. Motor agnóstico que inyecta metadatos semánticos en el código fuente y genera un rag-indexer.json para que los LLMs entiendan arquitecturas complejas ahorrando millones de tokens.
Instalación
pip install rag-context-indexer
Uso
# En la raíz de tu proyecto:
# 1. Scaffold: inyecta bloques @RAG_CONTEXT vacíos + genera .ai/prompts/
rag-indexer prepare
# 2. Instalar el pre-commit hook (una sola vez)
rag-indexer init
# 3. Ejecutar indexación manual (requiere API key)
rag-indexer run
Configuración
Crea un archivo .env en la raíz de tu proyecto:
# LLM activo: openai | anthropic | gemini | deepseek
ACTIVE_LLM=openai
# API Keys (solo la del LLM activo es necesaria)
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
GEMINI_API_KEY=AIza...
DEEPSEEK_API_KEY=sk-...
# Opcional: usar modelos de razonamiento pesados
USE_CODE_MODEL=false
Modelos soportados
| LLM | Tier Default | Tier Code |
|---|---|---|
| OpenAI | gpt-4o-mini | gpt-4o |
| Anthropic | claude-3-haiku | claude-3-5-sonnet-latest |
| Gemini | gemini-2.5-flash | gemini-2.5-pro |
| DeepSeek | deepseek-chat | deepseek-coder |
Plantilla JSON inyectada por archivo
{
"archivo": "ruta/relativa/al/archivo.ext",
"lineas": 0,
"tokens_estimados": 0,
"hash_contenido": "sha256_del_codigo_limpio",
"creacion": "YYYY-MM-DD",
"modificacion": "YYYY-MM-DD",
"tags": ["dependencia1", "exportacion_principal"],
"descripcion_corta": "Máx 50 chars.",
"descripcion_larga": "100-500 chars, técnico."
}
Plantillas generadas por rag-indexer prepare
Además de los bloques @RAG_CONTEXT en cada archivo, prepare genera en .ai/prompts/:
01_buenas_practicas.md— Constitución de ingeniería: Conventional Commits, Clean Code, seguridad, planificación, protocolo de confirmación con 3 banderas (RESUMEN / TECNICA / RESUMDA)02_menu_sesion.md— Menú de 15 opciones para gestionar sesiones con la IA (solo se crea si no existe, para que puedas personalizarlo)
Convención de commits enriquecida
Para máxima trazabilidad, los commits pueden incluir un JSON body con campos opcionales:
git commit -m "$(cat <<'EOF'
fix(modulo): descripción del fix
{
"resuelve": "Descripción del bug cerrado",
"antes": "Comportamiento anterior (síntoma visible)",
"deuda_tecnica": "Limitación pendiente (si aplica)"
}
EOF
)"
Estos campos son parseados automáticamente por rag-indexer trace (v2.0.0, próximamente).
Sistema de Trazabilidad (rag-indexer trace)
Vincula cada commit con la decisión técnica original que lo causó. Ideal para debugging: dado un bug en la línea N de un archivo, encuentra exactamente qué interacción con la IA generó ese cambio y por qué.
# 1. Inicializar (una sola vez por proyecto)
rag-indexer trace-init
# 2. A partir de aquí, cada `git commit` actualiza el contexto automáticamente
# 3. Procesar historial existente
rag-indexer trace-backfill
# 4. Query de trazabilidad manual
git log -L 42,42:src/mi_archivo.py --pretty="%h %s"
grep -r "HASH_ENCONTRADO" .ai/contexto/
Genera en .ai/contexto/:
contexto_activo.json— últimas 25 interacciones con commits y decisiones técnicascontexto_resumen.json— índice de bloques históricosarchivo/contexto_NNN.json— bloques archivados (25 interacciones c/u)
Auto-detección de sesiones: detecta automáticamente el directorio de sesiones de Claude Code (~/.claude/projects/{slug}/). Para otras IAs, establece RAG_TRACE_SESSIONS_DIR=/ruta/manual en .env.
Persistencia de sesión (rag-indexer tmux-*)
Mantiene la sesión de tu AI CLI activa aunque se caiga la terminal o se corte la conexión SSH. Ahorra tokens al no tener que re-explicar el contexto a la IA en cada reconexión.
# 1. Configurar e inicializar (detecta/instala tmux automáticamente)
rag-indexer tmux-init
# 2. Conectar o reconectar a la sesión del proyecto
rag-indexer tmux-attach
# 3. Ver estado de la sesión actual
rag-indexer tmux-status
# 4. Listar todas las sesiones rag-indexer activas
rag-indexer tmux-list
# 5. Eliminar la sesión del proyecto
rag-indexer tmux-del-session
Las sesiones se nombran {directorio}___rag-indexer (ej. mi-proyecto___rag-indexer) y tienen dos ventanas predefinidas:
- [AI] — lanza tu AI CLI automáticamente (
RAG_AI_CMD=claudepor defecto) - [Shell] — terminal bash limpia para git, logs y comandos
Variables .env:
RAG_TMUX_ENABLED=true
RAG_AI_CMD=claude # claude | cursor | aider | cualquier CLI
RAG_TMUX_SESSION=mi-proyecto___rag-indexer # auto-generado, sobreescribible
⚠️ Las sesiones tmux no persisten reboots. Tras reiniciar el servidor, ejecuta
rag-indexer tmux-attachpara recrear la sesión.
Gestores de paquetes soportados para instalación automática: apt, apt-get, dnf, yum, pacman, brew.
Principios de diseño
- Idempotencia: el hash SHA256 del código limpio evita llamadas innecesarias a la API
- Anti vendor lock-in: sin SDKs de terceros, solo
requestsvía REST - Control de costos: variable
USE_CODE_MODELalterna entre tiers de modelos - Contexto de ejecución: siempre escanea
os.getcwd(), no la ubicación del script
Licencia
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rag_context_indexer-1.12.1.tar.gz.
File metadata
- Download URL: rag_context_indexer-1.12.1.tar.gz
- Upload date:
- Size: 34.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ea4b8f41c1ce358834dccb324451b75f55b8114e924d70a70d44f28e7d396698
|
|
| MD5 |
1dbdc89b1463e548b78933f5565551ce
|
|
| BLAKE2b-256 |
c84b3ea01267bb2376ec16716315ecf822913d496bda8ca0188cc4a0649496ac
|
File details
Details for the file rag_context_indexer-1.12.1-py3-none-any.whl.
File metadata
- Download URL: rag_context_indexer-1.12.1-py3-none-any.whl
- Upload date:
- Size: 39.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fcbcd5f551f9b2b1a72c01c81ebe7db0af8626f1c0e4456951bb973a3502e5f3
|
|
| MD5 |
61087f933d857fa6b3302e936c12f19c
|
|
| BLAKE2b-256 |
dafb77e16174435747494dac33399356710cf67cf3ef8f824a12e764f5aaaf3c
|