@qubiit/lmagent 3.0.1 → 3.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/.agents/config/models.yaml +1 -1
  2. package/.agents/config/settings.yaml +9 -1
  3. package/.agents/docs/commands.md +46 -132
  4. package/.agents/docs/customization-guide.md +24 -432
  5. package/.agents/docs/getting-started.md +49 -126
  6. package/.agents/docs/how-to-start.md +20 -232
  7. package/.agents/docs/navigation-index.md +17 -227
  8. package/.agents/docs/usage-guide.md +17 -108
  9. package/.agents/memory/01-project.md +17 -0
  10. package/.agents/memory/02-tech-updates.md +16 -0
  11. package/.agents/memory/03-learnings.md +12 -0
  12. package/.agents/memory/04-active-context.md +14 -0
  13. package/.agents/memory/05-product-state.md +13 -0
  14. package/.agents/rules/02-tech-stack.md +33 -32
  15. package/.agents/rules/03-code-style.md +1 -1
  16. package/.agents/rules/08-agents-ai.md +22 -611
  17. package/.agents/rules/09-automations.md +15 -642
  18. package/.agents/rules/10-git-flow.md +34 -122
  19. package/.agents/scripts/create_skill.js +1 -1
  20. package/.agents/scripts/validate_skills.js +2 -2
  21. package/.agents/templates/backend-node/Dockerfile +1 -1
  22. package/.agents/templates/backend-node/package.json +10 -10
  23. package/.agents/templates/backend-python/Dockerfile +1 -1
  24. package/.agents/templates/backend-python/requirements-dev.txt +5 -6
  25. package/.agents/templates/backend-python/requirements.txt +4 -4
  26. package/.agents/templates/frontend-react/Dockerfile +19 -0
  27. package/.agents/templates/frontend-react/package.json +31 -0
  28. package/.agents/templates/frontend-react/postcss.config.js +6 -0
  29. package/.agents/templates/frontend-react/tailwind.config.js +11 -0
  30. package/.agents/templates/frontend-react/tsconfig.app.json +35 -0
  31. package/.agents/templates/frontend-react/tsconfig.json +11 -0
  32. package/.agents/templates/frontend-react/tsconfig.node.json +24 -0
  33. package/.agents/templates/frontend-react/vite.config.ts +17 -0
  34. package/.agents/workflows/n8n/README.md +3 -0
  35. package/AGENTS.md +3 -2
  36. package/CONTRIBUTING.md +2 -2
  37. package/README.md +1 -1
  38. package/install.js +123 -87
  39. package/package.json +5 -2
@@ -1,154 +1,77 @@
1
- # Guía de Inicio Rápido (Getting Started)
1
+ # 🚀 Getting Started with LMAgent
2
2
 
3
- Bienvenido a **LMAgent**, tu framework para desarrollo asistido por IA. Esta guía te llevará desde cero hasta estar productivo con tus agentes.
3
+ Bienvenido a **LMAgent v3.0.3**, el framework que transforma tu IDE en una agencia de desarrollo de software.
4
4
 
5
- ## 1. Instalación
5
+ ## 1. Requisitos Previos
6
+ - **Node.js**: v18+ (Requerido para el CLI).
7
+ - **IDE**: Cursor, VSCode, Windsurf o cualquier editor que soporte `.cursorrules` o contexto por archivo.
8
+ - **LLM**: Una key de OpenAI, Anthropic o Google configurada en tu IDE.
6
9
 
7
- ### Requisitos previos
8
- - Python 3.12+
9
- - Git
10
- - Un IDE agéntico (Antigravity, Cursor, Windsurf, VS Code + Claude/Copilot)
11
- - API Keys para tus LLMs (OpenAI, Anthropic, Google)
10
+ ## 2. Instalación e Inicialización
12
11
 
13
- ### Instalación del CLI
14
- Para tener el comando `lmagent` disponible en tu terminal:
12
+ ### Opción A: Proyecto Nuevo (Recomendado)
13
+ Para empezar un proyecto con toda la estructura lista:
15
14
 
16
- 1. Clona el repositorio oficial:
17
15
  ```bash
18
- git clone https://github.com/QuBiit0/lmagent.git
19
- cd lmagent
20
- ```
21
-
22
- 2. Instala el paquete en modo editable:
23
- ```bash
24
- pip install -e .
25
- ```
26
-
27
- 3. Verifica que funcione:
28
- ```bash
29
- lmagent --version
30
- # Debería mostrar: LMAgent v3.0.0
31
- ```
32
-
33
- ### Opción A: Proyecto Nuevo (Desde Cero)
34
- ```bash
35
- # 1. Crea el directorio
16
+ # 1. Crea tu directorio
36
17
  mkdir mi-nuevo-proyecto
37
18
  cd mi-nuevo-proyecto
38
19
 
39
- # 2. Inicializa el framework
40
- lmagent init
20
+ # 2. Inicializa LMAgent (No requiere instalación global)
21
+ npx @qubiit/lmagent@latest init
41
22
  ```
42
- Esto creará la estructura base y estarás listo para empezar.
43
23
 
44
- ### Opción B: Proyecto Existente (Legacy/Brownfield)
45
- LMAgent es **no-intrusivo**. No tocará tu código fuente, solo agregará una capa de inteligencia.
24
+ ### Opción B: Proyecto Existente
25
+ Agrega inteligencia a tu código legacy sin tocar tu código fuente:
46
26
 
47
27
  ```bash
48
- # 1. Ve a la raíz de tu proyecto
49
- cd mi-proyecto-existente
50
-
51
- # 2. Inicializa el framework
52
- lmagent init
28
+ cd mi-proyecto-brownfield
29
+ npx @qubiit/lmagent@latest init
53
30
  ```
54
31
 
55
- **¿Qué pasará?**
56
- - Se creará la carpeta `.agent/` (el cerebro del agente).
57
- - Se añadirán archivos de configuración para tu IDE (`CLAUDE.md`, `.cursorrules`).
58
- - **Tu código fuente (`src/`, `app/`, etc.) permanecerá intacto.**
59
-
60
- **Recomendación**: Después de inicializar, pídele al agente:
61
- > "Analiza la estructura de este proyecto y crea un `rules/project.md` con las convenciones que veas."
62
-
63
- ## 2. Configuración Básica
64
-
65
- 1. **Variables de Entorno**:
66
- Copia el ejemplo y edita tus claves:
67
- ```bash
68
- cp .env.example .env
69
- # Edita .env con tus API KEYS
70
- ```
71
-
72
- 2. **Verifica la instalación**:
73
- ```bash
74
- lmagent doctor
75
- ```
76
- Deberías ver "✨ All checks passed!".
32
+ ### ¿Qué acaba de pasar?
33
+ El comando `init`:
34
+ 1. Creó `.agents/` con la estructura de reglas y configuración.
35
+ 2. Copió `AGENTS.md` (El cerebro central) y `CLAUDE.md` (Contexto para LLMs).
36
+ 3. Configuró `.gitignore` para no subir archivos basura.
77
37
 
78
- ## 3. Tu Primera Tarea con el Agente
38
+ ## 3. Instalación de Skills (Bridge)
39
+ Para que tu IDE entienda los skills, necesitas instalarlos localmente:
79
40
 
80
- LMAgent está diseñado para trabajar **contigo** en el chat de tu IDE.
81
-
82
- ### Paso 1: Entender el Contexto
83
- Abre el chat y dile al agente:
84
- > "Hola, soy nuevo en este proyecto. ¿Puedes explicarme la estructura y qué personas tienes disponibles?"
85
-
86
- ### Paso 2: Activar una Persona
87
- Si vas a trabajar en backend, activa al experto:
88
- > "Actúa como @Backend Engineer /dev"
89
-
90
- El agente adoptará el rol, conocimientos y reglas de esa persona.
91
-
92
- ### Paso 3: Ejecutar un Workflow
93
- Vamos a crear una automatización simple. Dile al agente:
94
- > "Quiero crear una nueva automatización de n8n. Usa el workflow /new-automation"
95
-
96
- El agente:
97
- 1. Leerá `workflows/new-automation.md`
98
- 2. Te guiará paso a paso
99
- 3. Creará los archivos necesarios
100
-
101
- ## 4. Tu Primer Día: Guía Paso a Paso
102
-
103
- Si arrancas de cero, **no escribas código todavía**. Sigue este "script" de conversación con el agente:
104
-
105
- ### Paso 0: El "Super Prompt" (Opcional pero Recomendado) 🚀
106
- Si ya tienes la idea clara, no pierdas tiempo chateando.
41
+ ```bash
42
+ npx lmagent install
43
+ ```
44
+ Selecciona tu IDE (ej. Cursor) y elige **"Instalación Rápida"**.
45
+ Esto creará enlaces simbólicos (o copias) en `.cursor/rules` apuntando a `.agents/skills`.
107
46
 
108
- 1. Copia la plantilla de **`templates/project_brief.md`**.
109
- 2. Llénala con tus datos.
110
- 3. Pégala en el chat:
111
- > "Hola **/orch**. Aquí está el brief de mi proyecto. Inicia el trabajo."
47
+ ---
112
48
 
113
- El Orchestrator leerá todo y asignará tareas al PM y Arquitecto automáticamente.
49
+ ## 4. Tu Primer Flujo de Trabajo
114
50
 
115
- ### Paso 1: Definir el "QUÉ" (con el Product Manager)
116
- Activa al PM y cuéntale tu idea abstracta.
117
- > "Hola **/pm**. Quiero crear una aplicación para gestionar gastos personales que sea muy simple. Ayúdame a definir los requerimientos y un MVP."
51
+ ### Paso 1: Define el Proyecto (Memoria)
52
+ Edita `.agents/memory/01-project.md`. Dile al agente quién eres y qué construyes.
53
+ *Ejemplo:*
54
+ > "Este es un SaaS de gestión de gastos para freelancers en Latam."
118
55
 
119
- El agente te hará preguntas. Respóndelas hasta que genere un **PRD** (Product Requirements Document).
56
+ ### Paso 2: Activa un Skill
57
+ Abre el chat de tu IDE (Ctrl+L / Cmd+L) y escribe:
58
+ > "Hola `/pm`. Lee la memoria del proyecto y ayúdame a crear las historias de usuario para el Login."
120
59
 
121
- ### Paso 2: Definir el "CÓMO" (con el Architect)
122
- Una vez tengas el PRD (o una idea clara), llama al Arquitecto.
123
- > "Hola **/arch**. Basado en lo que definimos con el PM, define el stack tecnológico ideal y crea la estructura de carpetas inicial. Crea también un archivo `rules/project.md` con las convenciones."
60
+ El agente detectará `/pm`, leerá las reglas de **Product Manager** y actuará en consecuencia.
124
61
 
125
- ### Paso 3: Empezar a Construir (con el Developer)
126
- Con el plan y las reglas listas, empieza a codear.
127
- > "Hola **/dev**. Vamos a implementar la estructura base que definió el arquitecto. Empieza por inicializar el proyecto (package.json o pyproject.toml)."
62
+ ### Paso 3: Código
63
+ Luego, cambia de sombrero:
64
+ > "Gracias PM. Ahora `/dev`, implementa el Login en Next.js siguiendo las historias de usuario."
128
65
 
129
66
  ---
130
67
 
131
- ## 5. Conceptos Clave
132
-
133
- ### 🎭 Personas
134
- Son roles especializados que el agente adopta. Cada uno tiene sus propias instrucciones y "superpoderes".
135
- - **/pm** - Product Manager (Define QUÉ hacer)
136
- - **/arch** - Architect (Define CÓMO hacerlo)
137
- - **/dev** - Backend Dev (Escribe el código)
138
- - **/qa** - QA Engineer (Escribe los tests)
139
- - **/prompt** - Prompt Engineer (Diseña la lógica cognitiva)
140
-
141
- ### 📏 Niveles (Levels)
142
- Determinan cuánto "pensar" antes de "hacer".
143
- - **Level 0**: Trivial. Hazlo ya.
144
- - **Level 2**: Medium. Crea un plan (`implementation_plan.md`) y espera mi OK.
145
- - **Level 4**: Enterprise. Plan muy detallado, revisión de seguridad, aprobación humana obligatoria.
146
-
147
- ### 📜 Reglas Proactivas
148
- El agente lee tus reglas en `.agent/rules/`. Si rompes una regla (ej. "No usar prints"), el agente te corregirá o lo arreglará automáticamente.
68
+ ## 5. Comandos Útiles
149
69
 
150
- ## 5. Siguientes Pasos
70
+ - `npx lmagent doctor`: Verifica que todo esté bien configurado.
71
+ - `npx lmagent update`: Actualiza tus skills a la última versión.
72
+ - `npx lmagent validate`: (Para creadores) Valida que tus skills custom sigan el estándar.
151
73
 
152
- - Lee la [Guía de Uso Completa](usage-guide.md) para dominar el framework.
153
- - Explora las [Personas](../personas/) disponibles.
154
- - Revisa los [Workflows](../workflows/) para automatizar tus tareas repetitivas.
74
+ ## 🔗 Referencias
75
+ - [Guía de Uso Completa](usage-guide.md)
76
+ - [Índice de Comandos](commands.md)
77
+ - [Reglas del Sistema](../rules/00-master.md)
@@ -1,242 +1,30 @@
1
- # Cómo Empezar un Proyecto con LMAgent
1
+ # 🤖 Tu Primera Interacción con LMAgent
2
2
 
3
- > **LMAgent Framework v3.0 (SPEC+LM)**
4
- >
5
- > Esta guía explica el proceso automatizado para iniciar un nuevo proyecto.
3
+ Una vez instalado LMAgent, sigue este guión para tu primera sesión de trabajo.
6
4
 
7
- ---
5
+ ## 1. El Check-in Inicial
6
+ Abre el chat de tu IDE y preséntate al sistema.
8
7
 
9
- ## 🎯 Resumen del Flujo
8
+ > "Hola. Soy nuevo en este proyecto. Lee `AGENTS.md` y explícame qué roles tengo disponibles."
10
9
 
11
- ```
12
- ┌─────────────────────────────────────────────────────────────────────────────┐
13
- │ FLUJO AUTOMATIZADO DE INICIO │
14
- │ │
15
- │ DESARROLLADOR AGENTE DE IA │
16
- │ ───────────── ───────────── │
17
- │ │
18
- │ 1. Crear carpeta del proyecto │
19
- │ │ │
20
- │ ▼ │
21
- │ 2. Crear PROJECT_KICKOFF.md ──────────┐ │
22
- │ (5-10 minutos) │ │
23
- │ │ │
24
- │ 3. Abrir en IDE agéntico │ │
25
- │ │ │ │
26
- │ ▼ ▼ │
27
- │ ┌─────────────────────────────────────────────────────────────────────┐ │
28
- │ │ AUTOMÁTICO (Sin intervención) │ │
29
- │ │ │ │
30
- │ │ 4. Agente detecta PROJECT_KICKOFF.md │ │
31
- │ │ 5. Ejecuta: lmagent init │ │
32
- │ │ 6. Ejecuta: /spec workflow │ │
33
- │ │ 7. Crea: spec.yaml → plan.yaml → tasks.yaml │ │
34
- │ │ 8. Implementa código siguiendo tasks │ │
35
- │ │ 9. Tests + Documentación │ │
36
- │ │ │ │
37
- │ └─────────────────────────────────────────────────────────────────────┘ │
38
- │ │
39
- │ 10. USUARIO: Revisar y aprobar cada fase │
40
- │ │
41
- └─────────────────────────────────────────────────────────────────────────────┘
42
- ```
10
+ El agente leerá su propia configuración y te listará los skills activos.
43
11
 
44
- ---
12
+ ## 2. La Primera Tarea (Ejemplo)
13
+ Supongamos que quieres crear un endpoint de Login.
45
14
 
46
- ## 📋 Paso a Paso
15
+ ### Paso A: Invoca al Experto
16
+ > "Actúa como `/dev`. Vamos a crear un endpoint de login en Node.js."
47
17
 
48
- ### Paso 1: Crear Carpeta del Proyecto
18
+ ### Paso B: Dale Contexto
19
+ > "El login debe usar JWT y validar contra una base de datos PostgreSQL. Usa las reglas de `04-security.md`."
49
20
 
50
- ```bash
51
- mkdir mi-nuevo-proyecto
52
- cd mi-nuevo-proyecto
53
- ```
21
+ ### Paso C: Refinamiento
22
+ El agente te mostrará un plan o código.
23
+ > "Eso se ve bien, pero agrega validación de email con Zod."
54
24
 
55
- ### Paso 2: Crear PROJECT_KICKOFF.md
25
+ ## 3. Comandos Mágicos
26
+ Recuerda estos atajos para el chat:
56
27
 
57
- Copia el template desde el repositorio de LMAgent:
58
-
59
- ```bash
60
- # Si tienes LMAgent instalado globalmente:
61
- lmagent kickoff
62
-
63
- # O manualmente, copia el archivo:
64
- cp /path/to/lmagent/templates/PROJECT_KICKOFF.md ./PROJECT_KICKOFF.md
65
- ```
66
-
67
- ### Paso 3: Completar el Template (OPCIONAL)
68
-
69
- Abre `PROJECT_KICKOFF.md` y tienes DOS opciones:
70
-
71
- #### Opción A: Completar manualmente (5-10 minutos)
72
- Llena las secciones marcadas con `[...]`. Solo necesitas:
73
- - Nombre del proyecto
74
- - Descripción en una línea
75
- - Tipo de proyecto
76
- - Usuario principal
77
- - Problema a resolver
78
- - 2-5 features MUST HAVE
79
-
80
- #### Opción B: Dejar que el agente pregunte
81
- Si no completas el template, el agente detectará que está vacío y te hará las preguntas necesarias en el chat:
82
-
83
- ```
84
- Agente: "Detecté que este es un proyecto nuevo. Voy a hacerte
85
- algunas preguntas para entender qué quieres construir."
86
-
87
- "¿Cómo se llama tu proyecto?"
88
-
89
- Tú: "NutriTrack AI"
90
-
91
- Agente: "En una frase, ¿qué es y para quién?"
92
-
93
- Tú: "App para rastrear nutrición con IA que analiza fotos de comida"
94
-
95
- ... (5-7 preguntas en total)
96
- ```
97
-
98
- ### Paso 4: Abrir en tu IDE Agéntico
99
-
100
- Abre la carpeta del proyecto en tu IDE favorito:
101
-
102
- | IDE | Cómo Abrir |
103
- |-----|-----------|
104
- | **Cursor** | `cursor .` |
105
- | **Claude Code** | `claude .` |
106
- | **Antigravity** | Abrir carpeta en VS Code + extensión |
107
- | **Copilot** | Abrir en VS Code |
108
-
109
- ### Paso 5: El Agente Toma el Control 🤖
110
-
111
- Una vez que el IDE agéntico analice tu carpeta, detectará `PROJECT_KICKOFF.md` y comenzará automáticamente:
112
-
113
- 1. **Detecta Framework** → Inicializa LMAgent
114
- 2. **Lee tu Kickoff** → Entiende el proyecto
115
- 3. **Ejecuta /spec** → Crea especificación formal
116
- 4. **Te muestra spec.yaml** → Pide aprobación
117
- 5. **Diseña arquitectura** → Crea plan.yaml
118
- 6. **Te muestra el plan** → Pide aprobación
119
- 7. **Crea tasks** → Desglose de implementación
120
- 8. **Implementa** → Código real
121
-
122
- ---
123
-
124
- ## 🔄 Puntos de Aprobación
125
-
126
- El agente se detendrá y pedirá tu aprobación en estos puntos:
127
-
128
- ```
129
- ┌────────────────┐
130
- │ spec.yaml │ ← "¿Está bien el alcance y las features?"
131
- └───────┬────────┘
132
- │ ✅ Aprobado
133
-
134
- ┌────────────────┐
135
- │ plan.yaml │ ← "¿Está bien la arquitectura y el plan?"
136
- └───────┬────────┘
137
- │ ✅ Aprobado
138
-
139
- ┌────────────────┐
140
- │ tasks.yaml │ ← "¿Puedo empezar a implementar?"
141
- └───────┬────────┘
142
- │ ✅ Aprobado
143
-
144
- 🚀 IMPLEMENTACIÓN
145
- ```
146
-
147
- ---
148
-
149
- ## 📂 Estructura Final del Proyecto
150
-
151
- Después del proceso, tu proyecto tendrá esta estructura:
152
-
153
- ```
154
- mi-nuevo-proyecto/
155
- ├── PROJECT_KICKOFF.md # Tu input original
156
- ├── AGENTS.md # Main entry point de LMAgent
157
- ├── .lmagent # Marker del framework
158
- ├── README.md # Generado automáticamente
159
-
160
- ├── specs/
161
- │ └── mi-nuevo-proyecto/
162
- │ ├── spec.yaml # Especificación formal
163
- │ ├── plan.yaml # Plan de arquitectura
164
- │ └── tasks.yaml # Tasks desglosadas
165
-
166
- ├── src/ # Código fuente
167
- │ ├── app/
168
- │ ├── services/
169
- │ └── ...
170
-
171
- ├── tests/ # Tests automatizados
172
-
173
- ├── docs/ # Documentación
174
- │ └── adr/ # Architecture Decision Records
175
-
176
- ├── docker-compose.yml # Si aplica
177
- └── pyproject.toml # O package.json
178
- ```
179
-
180
- ---
181
-
182
- ## ⚡ Comandos Útiles
183
-
184
- Una vez que el proyecto está inicializado:
185
-
186
- | Comando | Qué Hace |
187
- |---------|----------|
188
- | `/spec status` | Ver estado del spec actual |
189
- | `/spec validate` | Validar implementación vs spec |
190
- | `/pm` | Activar Product Manager para cambios de requisitos |
191
- | `/arch` | Activar Architect para decisiones técnicas |
192
- | `/dev` | Activar Developer para implementar |
193
- | `/qa` | Activar QA para testing |
194
-
195
- ---
196
-
197
- ## ❓ FAQ
198
-
199
- ### ¿Qué pasa si quiero cambiar algo después?
200
-
201
- Simplemente dile al agente:
202
- ```
203
- "Quiero agregar feature X al proyecto"
204
- ```
205
- El agente actualizará spec.yaml y te pedirá aprobación.
206
-
207
- ### ¿Puedo usar LMAgent en un proyecto existente?
208
-
209
- Sí, ejecuta:
210
- ```bash
211
- cd mi-proyecto-existente
212
- lmagent init
213
- ```
214
- Luego crea un PROJECT_KICKOFF.md describiendo lo que quieres agregar.
215
-
216
- ### ¿Qué IDEs son compatibles?
217
-
218
- - ✅ Cursor
219
- - ✅ Claude Code
220
- - ✅ Antigravity (VS Code)
221
- - ✅ GitHub Copilot
222
- - ✅ Windsurf
223
- - ✅ Roo Code
224
-
225
- ---
226
-
227
- ## 🎬 Video Demo (Conceptual)
228
-
229
- ```
230
- 00:00 - Crear carpeta y PROJECT_KICKOFF.md
231
- 00:05 - Completar template (fast-forward)
232
- 00:15 - Abrir en Cursor
233
- 00:20 - Agente detecta y comienza
234
- 00:30 - spec.yaml generado, revisión
235
- 00:40 - plan.yaml generado, revisión
236
- 00:50 - Implementación automática
237
- 02:00 - Proyecto MVP funcionando 🎉
238
- ```
239
-
240
- ---
241
-
242
- *LMAgent v3.0.0 (SPEC+LM) - Build More, Automate Dreams* 🚀
28
+ - **`/orch`**: "Estoy perdido, ayúdame a empezar".
29
+ - **`/test`**: "Crea tests para este archivo".
30
+ - **`/fix`**: "Arregla este error que veo en la terminal".