@dami_deleon/rikudo 1.0.1-alpha.0 → 1.0.1-alpha.2

package/README.md

@@ -1,6 +1,6 @@
 # 🌀 Rikudo: El Sabio de los Commits
 
-**Rikudo** es una herramienta de terminal (CLI) potenciada por Inteligencia Artificial (Google Gemini) diseñada para automatizar y estandarizar el flujo de trabajo de Git y la gestión de tareas en Redmine. 
+**Rikudo** es una herramienta de terminal (CLI) potenciada por Inteligencia Artificial diseñada para automatizar y estandarizar el flujo de trabajo de Git y la gestión de tareas en Redmine. 
 
 Inspirado en el Sabio de los Seis Caminos, Rikudo utiliza seis módulos especializados para observar tu código, entender el contexto de tus tareas y mantener la armonía en el repositorio siguiendo estrictamente las convenciones del equipo.
 
@@ -15,48 +15,155 @@ Inspirado en el Sabio de los Seis Caminos, Rikudo utiliza seis módulos especial
 5.  **Camino Naraka (Cache):** Memoria persistente basada en hashes de Git para optimizar tokens.
 6.  **Camino Asura (Rate Limiter):** Gestión de poder para respetar los límites de las APIs.
 
----
+¡Claro que sí! Aquí tienes una versión profesional, estructurada y atractiva para tu `README.md`.
 
-## 🛠️ Requisitos Previos
+He destacado las características clave que mencionaste (Multi-AI, Templates y Diagnóstico) y he añadido secciones útiles como instalación y configuración.
 
-- **Node.js** (v18 o superior)
-- **Git** instalado y configurado.
-- Una **API Key de Google Gemini**.
-- Acceso a la **API de Redmine** de tu organización.
+Copia y pega el siguiente contenido en tu archivo `README.md`:
 
----
+
+## ✨ Características Principales
+
+* **🧠 Multi-Provider AI:** Tú eliges el cerebro. Soporte nativo para:
+* **Google Gemini** (Rápido y eficiente)
+* **OpenAI GPT-4o / GPT-3.5** (El estándar)
+* **Anthropic Claude** (Gran capacidad de contexto)
+* **Ollama** (Privacidad total con modelos locales como Llama 3)
+
+
+* **📝 Smart Commits:** Analiza tus `staged files` y genera mensajes siguiendo **Conventional Commits** basados en tus propias reglas.
+* **🚀 PR Generator:** Selecciona múltiples commits y genera una descripción de Pull Request completa siguiendo tu plantilla.
+* **⚙️ Configuración Flexible:** Define tus preferencias globales o por proyecto.
+* **🔍 Diagnóstico Integrado:** Herramienta `test` para verificar tus API Keys y conexión con servicios externos (Redmine, IA, etc.).
 
 ## 📦 Instalación
 
-1.  **Clonar y preparar el proyecto:**
-    ```bash
-    git clone <url-de-tu-repo-rikudo>
-    cd rikudo
-    npm install
-    ```
+Rikudo está disponible en npm (actualmente en Alpha).
 
-2.  **Compilar e Instalar Globalmente:**
-    ```bash
-    npm run build
-    npm link
-    ```
+### Uso global (Recomendado)
+
+```bash
+npm install -g @dami_deleon/rikudo@alpha
+
+```
+
+### Ejecución única (sin instalar)
+
+```bash
+npx @dami_deleon/rikudo@alpha
+
+```
+
+## 🚀 Uso Rápido
+
+Simplemente ejecuta el comando en tu terminal dentro de cualquier repositorio git:
+
+```bash
+rikudo
+
+```
+
+Esto abrirá el **Menú Interactivo** donde podrás elegir entre crear commits, PRs o configurar la herramienta.
+
+### Comandos Directos
+
+Si eres un power-user, puedes usar atajos:
+
+* **Crear Commit:**
+```bash
+rikudo commit
+# O con ticket asociado:
+rikudo commit -t 1234
+
+```
+
+
+* **Crear Pull Request:**
+```bash
+rikudo pr
+# O con ticket asociado:
+rikudo pr -t 1234
+
+```
+
+
+* **Diagnóstico de Conexión:**
+```bash
+rikudo test
+
+```
+
+
+* **Configuración:**
+```bash
+rikudo config
+
+```
 
-Ahora el comando `rikudo` estará disponible en cualquier terminal de tu sistema.
 
----
 
 ## ⚙️ Configuración
 
-### 1. Variables de Entorno (`.env`)
-Crea un archivo `.env` en la raíz del proyecto (no olvides agregarlo a tu `.gitignore` global):
+Rikudo busca un archivo `.env` en la raíz de tu proyecto para las credenciales sensibles.
+
+Crea un archivo `.env` y añade las variables según el proveedor que quieras usar:
 
 ```env
-# Credenciales
-GEMINI_API_KEY=tu_clave_aqui
-REDMINE_URL=[https://redmine.tuempresa.com](https://redmine.tuempresa.com)
-REDMINE_API_KEY=tu_clave_de_redmine
-
-# Límites de la API (Evita el error 429)
-AI_REQUESTS_PER_DAY=1500
-AI_REQUESTS_PER_MINUTE=15
-AI_TOKENS_PER_MINUTE=1000000
+# --- Configuración General ---
+RIKUDO_AI_PROVIDER=gemini  # Opciones: gemini, openai, claude, ollama
+
+# --- Credenciales de Proveedores (Solo necesitas la que uses) ---
+RIKUDO_GEMINI_API_KEY=tu_api_key_aqui
+RIKUDO_OPENAI_API_KEY=tu_api_key_aqui
+RIKUDO_CLAUDE_API_KEY=tu_api_key_aqui
+
+# --- Ollama (Local) ---
+RIKUDO_OLLAMA_URL=http://localhost:11434/api/generate
+RIKUDO_OLLAMA_MODEL=llama3
+
+# --- Integraciones (Opcional) ---
+RIKUDO_REDMINE_URL=https://redmine.tuempresa.com
+RIKUDO_REDMINE_API_KEY=tu_redmine_key
+
+```
+
+### Plantillas Personalizadas (Templates)
+
+Puedes personalizar cómo Rikudo escribe. Coloca estos archivos en la raíz de tu proyecto:
+
+1. **`conventions.txt`**: Reglas para tus commits.
+* *Ejemplo:* "Usa emojis al inicio. Formato: <emoji> <tipo>: <mensaje>."
+
+
+2. **`pull-request-template.txt`**: Estructura para tus PRs.
+* *Ejemplo:*
+```markdown
+# Cambios
+- ...
+# Tickets Relacionados
+- ...
+
+```
+
+
+
+
+
+## 🛠️ Solución de Problemas
+
+Si tienes problemas de conexión o configuración, ejecuta el diagnóstico:
+
+```bash
+rikudo test
+
+```
+
+Esto validará:
+
+1. Que las variables de entorno existan.
+2. Que la API Key sea válida conectando con el proveedor.
+3. Que tengas acceso a los servicios externos configurados.
+
+---
+
+Hecho con ❤️ y TypeScript.

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dami_deleon/rikudo",
-  "version": "1.0.1-alpha.0",
+  "version": "1.0.1-alpha.2",
   "description": "El Sabio de los Commits: AI Assistant con integración a Redmine",
   "main": "dist/index.js",
   "type": "module",
   "bin": {
-    "rikudo": "./dist/index.js"
+    "rikudo": "dist/index.js"
   },
   "files": [
     "dist",