ai-flow-dev 2.7.0 → 2.8.0

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 (171) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +573 -570
  3. package/package.json +74 -74
  4. package/prompts/backend/flow-build-phase-0.md +535 -535
  5. package/prompts/backend/flow-build-phase-1.md +626 -626
  6. package/prompts/backend/flow-build-phase-10.md +340 -340
  7. package/prompts/backend/flow-build-phase-2.md +573 -573
  8. package/prompts/backend/flow-build-phase-3.md +834 -834
  9. package/prompts/backend/flow-build-phase-4.md +554 -554
  10. package/prompts/backend/flow-build-phase-5.md +703 -703
  11. package/prompts/backend/flow-build-phase-6.md +524 -524
  12. package/prompts/backend/flow-build-phase-7.md +1001 -1001
  13. package/prompts/backend/flow-build-phase-8.md +1407 -1407
  14. package/prompts/backend/flow-build-phase-9.md +477 -477
  15. package/prompts/backend/flow-build.md +137 -137
  16. package/prompts/backend/flow-check-review.md +656 -20
  17. package/prompts/backend/flow-check-test.md +526 -14
  18. package/prompts/backend/flow-check.md +725 -67
  19. package/prompts/backend/flow-commit.md +88 -119
  20. package/prompts/backend/flow-docs-sync.md +354 -354
  21. package/prompts/backend/flow-finish.md +919 -0
  22. package/prompts/backend/flow-release.md +949 -0
  23. package/prompts/backend/flow-work-feature.md +61 -61
  24. package/prompts/backend/flow-work-fix.md +46 -46
  25. package/prompts/backend/flow-work-refactor.md +48 -48
  26. package/prompts/backend/flow-work-resume.md +34 -34
  27. package/prompts/backend/flow-work.md +1098 -1286
  28. package/prompts/desktop/flow-build-phase-0.md +359 -359
  29. package/prompts/desktop/flow-build-phase-1.md +295 -295
  30. package/prompts/desktop/flow-build-phase-10.md +357 -357
  31. package/prompts/desktop/flow-build-phase-2.md +282 -282
  32. package/prompts/desktop/flow-build-phase-3.md +291 -291
  33. package/prompts/desktop/flow-build-phase-4.md +308 -308
  34. package/prompts/desktop/flow-build-phase-5.md +269 -269
  35. package/prompts/desktop/flow-build-phase-6.md +350 -350
  36. package/prompts/desktop/flow-build-phase-7.md +297 -297
  37. package/prompts/desktop/flow-build-phase-8.md +541 -541
  38. package/prompts/desktop/flow-build-phase-9.md +439 -439
  39. package/prompts/desktop/flow-build.md +156 -156
  40. package/prompts/desktop/flow-check-review.md +656 -20
  41. package/prompts/desktop/flow-check-test.md +526 -14
  42. package/prompts/desktop/flow-check.md +725 -67
  43. package/prompts/desktop/flow-commit.md +88 -119
  44. package/prompts/desktop/flow-docs-sync.md +354 -354
  45. package/prompts/desktop/flow-finish.md +910 -0
  46. package/prompts/desktop/flow-release.md +662 -0
  47. package/prompts/desktop/flow-work-feature.md +61 -61
  48. package/prompts/desktop/flow-work-fix.md +46 -46
  49. package/prompts/desktop/flow-work-refactor.md +48 -48
  50. package/prompts/desktop/flow-work-resume.md +34 -34
  51. package/prompts/desktop/flow-work.md +1202 -1390
  52. package/prompts/frontend/flow-build-phase-0.md +425 -425
  53. package/prompts/frontend/flow-build-phase-1.md +626 -626
  54. package/prompts/frontend/flow-build-phase-10.md +33 -33
  55. package/prompts/frontend/flow-build-phase-2.md +573 -573
  56. package/prompts/frontend/flow-build-phase-3.md +782 -782
  57. package/prompts/frontend/flow-build-phase-4.md +554 -554
  58. package/prompts/frontend/flow-build-phase-5.md +703 -703
  59. package/prompts/frontend/flow-build-phase-6.md +524 -524
  60. package/prompts/frontend/flow-build-phase-7.md +1001 -1001
  61. package/prompts/frontend/flow-build-phase-8.md +872 -872
  62. package/prompts/frontend/flow-build-phase-9.md +94 -94
  63. package/prompts/frontend/flow-build.md +137 -137
  64. package/prompts/frontend/flow-check-review.md +656 -20
  65. package/prompts/frontend/flow-check-test.md +526 -14
  66. package/prompts/frontend/flow-check.md +725 -67
  67. package/prompts/frontend/flow-commit.md +88 -119
  68. package/prompts/frontend/flow-docs-sync.md +550 -550
  69. package/prompts/frontend/flow-finish.md +910 -0
  70. package/prompts/frontend/flow-release.md +519 -0
  71. package/prompts/frontend/flow-work-api.md +1540 -0
  72. package/prompts/frontend/flow-work-feature.md +61 -61
  73. package/prompts/frontend/flow-work-fix.md +38 -38
  74. package/prompts/frontend/flow-work-refactor.md +48 -48
  75. package/prompts/frontend/flow-work-resume.md +34 -34
  76. package/prompts/frontend/flow-work.md +1583 -1320
  77. package/prompts/mobile/flow-build-phase-0.md +425 -425
  78. package/prompts/mobile/flow-build-phase-1.md +626 -626
  79. package/prompts/mobile/flow-build-phase-10.md +32 -32
  80. package/prompts/mobile/flow-build-phase-2.md +573 -573
  81. package/prompts/mobile/flow-build-phase-3.md +782 -782
  82. package/prompts/mobile/flow-build-phase-4.md +554 -554
  83. package/prompts/mobile/flow-build-phase-5.md +703 -703
  84. package/prompts/mobile/flow-build-phase-6.md +524 -524
  85. package/prompts/mobile/flow-build-phase-7.md +1001 -1001
  86. package/prompts/mobile/flow-build-phase-8.md +888 -888
  87. package/prompts/mobile/flow-build-phase-9.md +90 -90
  88. package/prompts/mobile/flow-build.md +135 -135
  89. package/prompts/mobile/flow-check-review.md +656 -20
  90. package/prompts/mobile/flow-check-test.md +526 -14
  91. package/prompts/mobile/flow-check.md +725 -67
  92. package/prompts/mobile/flow-commit.md +88 -119
  93. package/prompts/mobile/flow-docs-sync.md +620 -620
  94. package/prompts/mobile/flow-finish.md +910 -0
  95. package/prompts/mobile/flow-release.md +751 -0
  96. package/prompts/mobile/flow-work-api.md +1493 -0
  97. package/prompts/mobile/flow-work-feature.md +61 -61
  98. package/prompts/mobile/flow-work-fix.md +46 -46
  99. package/prompts/mobile/flow-work-refactor.md +48 -48
  100. package/prompts/mobile/flow-work-resume.md +34 -34
  101. package/prompts/mobile/flow-work.md +1593 -1329
  102. package/prompts/shared/mermaid-guidelines.md +102 -102
  103. package/prompts/shared/scope-levels.md +114 -114
  104. package/prompts/shared/smart-skip-preflight.md +214 -214
  105. package/prompts/shared/story-points.md +55 -55
  106. package/prompts/shared/task-format.md +74 -74
  107. package/prompts/shared/task-summary-template.md +277 -277
  108. package/templates/AGENT.template.md +443 -443
  109. package/templates/backend/.clauderules.template +112 -112
  110. package/templates/backend/.cursorrules.template +102 -102
  111. package/templates/backend/README.template.md +2 -2
  112. package/templates/backend/ai-instructions.template.md +2 -2
  113. package/templates/backend/copilot-instructions.template.md +2 -2
  114. package/templates/backend/docs/api.template.md +320 -320
  115. package/templates/backend/docs/business-flows.template.md +97 -97
  116. package/templates/backend/docs/code-standards.template.md +2 -2
  117. package/templates/backend/docs/contributing.template.md +3 -3
  118. package/templates/backend/docs/data-model.template.md +520 -520
  119. package/templates/backend/docs/testing.template.md +2 -2
  120. package/templates/backend/project-brief.template.md +2 -2
  121. package/templates/backend/specs/configuration.template.md +2 -2
  122. package/templates/backend/specs/security.template.md +2 -2
  123. package/templates/desktop/.clauderules.template +112 -112
  124. package/templates/desktop/.cursorrules.template +102 -102
  125. package/templates/desktop/README.template.md +170 -170
  126. package/templates/desktop/ai-instructions.template.md +366 -366
  127. package/templates/desktop/copilot-instructions.template.md +140 -140
  128. package/templates/desktop/docs/docs/api.template.md +320 -320
  129. package/templates/desktop/docs/docs/architecture.template.md +724 -724
  130. package/templates/desktop/docs/docs/business-flows.template.md +102 -102
  131. package/templates/desktop/docs/docs/code-standards.template.md +792 -792
  132. package/templates/desktop/docs/docs/contributing.template.md +149 -149
  133. package/templates/desktop/docs/docs/data-model.template.md +520 -520
  134. package/templates/desktop/docs/docs/operations.template.md +720 -720
  135. package/templates/desktop/docs/docs/testing.template.md +722 -722
  136. package/templates/desktop/project-brief.template.md +150 -150
  137. package/templates/desktop/specs/specs/configuration.template.md +121 -121
  138. package/templates/desktop/specs/specs/security.template.md +392 -392
  139. package/templates/frontend/README.template.md +2 -2
  140. package/templates/frontend/ai-instructions.template.md +2 -2
  141. package/templates/frontend/docs/api-integration.template.md +362 -362
  142. package/templates/frontend/docs/components.template.md +2 -2
  143. package/templates/frontend/docs/error-handling.template.md +360 -360
  144. package/templates/frontend/docs/operations.template.md +107 -107
  145. package/templates/frontend/docs/performance.template.md +124 -124
  146. package/templates/frontend/docs/pwa.template.md +119 -119
  147. package/templates/frontend/docs/state-management.template.md +2 -2
  148. package/templates/frontend/docs/styling.template.md +2 -2
  149. package/templates/frontend/docs/testing.template.md +2 -2
  150. package/templates/frontend/project-brief.template.md +2 -2
  151. package/templates/frontend/specs/accessibility.template.md +95 -95
  152. package/templates/frontend/specs/configuration.template.md +2 -2
  153. package/templates/frontend/specs/security.template.md +175 -175
  154. package/templates/fullstack/README.template.md +252 -252
  155. package/templates/fullstack/ai-instructions.template.md +444 -444
  156. package/templates/fullstack/project-brief.template.md +157 -157
  157. package/templates/fullstack/specs/configuration.template.md +340 -340
  158. package/templates/mobile/README.template.md +167 -167
  159. package/templates/mobile/ai-instructions.template.md +196 -196
  160. package/templates/mobile/docs/app-store.template.md +135 -135
  161. package/templates/mobile/docs/architecture.template.md +63 -63
  162. package/templates/mobile/docs/native-features.template.md +94 -94
  163. package/templates/mobile/docs/navigation.template.md +59 -59
  164. package/templates/mobile/docs/offline-strategy.template.md +65 -65
  165. package/templates/mobile/docs/permissions.template.md +56 -56
  166. package/templates/mobile/docs/state-management.template.md +85 -85
  167. package/templates/mobile/docs/testing.template.md +109 -109
  168. package/templates/mobile/project-brief.template.md +69 -69
  169. package/templates/mobile/specs/build-configuration.template.md +91 -91
  170. package/templates/mobile/specs/deployment.template.md +92 -92
  171. package/templates/work.template.md +47 -47
package/README.md CHANGED
@@ -1,570 +1,573 @@
1
- # AI Flow
2
-
3
- [![CI Status](https://github.com/victorvelazquez/ai-flow/actions/workflows/nodejs.yml/badge.svg)](https://github.com/victorvelazquez/ai-flow/actions/workflows/nodejs.yml)
4
-
5
- ## English
6
-
7
- Transform your idea into a production-ready, AI-documented project (backend, frontend, fullstack, mobile, or desktop) in minutes.
8
-
9
- AI Flow is an interactive CLI that creates comprehensive professional documentation and provides an AI-powered development workflow from idea to production. Compatible with Claude, Copilot, Cursor, Gemini, Antigravity, and any AI assistant.
10
-
11
- **Key Features:**
12
-
13
- - 🚀 Complete professional documentation (Backend: 17 files, Frontend: 15 files, Mobile: 13 files, Desktop: 16 files, Fullstack: 30+ files)
14
- - 🧠 **Smart Description Refinement:** Detects ambiguity and iteratively guides you to a professional project definition.
15
- - ⚡ **Two modes:** Interactive (90-120 min, full control) or Smart Auto-Suggest (15-25 min, 6 questions)
16
- - 🌍 Universal support - 12 languages, 60+ frameworks, 35+ ORMs (98% coverage)
17
- - 🤖 Multi-AI support with slash commands
18
- - 🔍 Smart 3-layer detection for existing projects (50-94% faster)
19
- - 🎯 **Smart Skip Logic:** Intelligently skips documentation phases for existing projects (15-20 min vs 90 min for ≥95% consistency).
20
- - 🚀 **Agent Mode Enforcement:** AI assistants now prioritize proactive tool usage and immediate execution for all `/flow-` commands (No more redundant planning).
21
- - ⏱️ Save 10-20 hours per project
22
-
23
- **Quick Start:**
24
-
25
- **Requirements:** Node.js ≥20.0.0
26
-
27
- ```bash
28
- npm install -g ai-flow-dev
29
- ai-flow init .
30
- # Then open your AI tool and run:
31
- # /flow-build - To generate all documentation
32
- # /flow-work - To start building features
33
- ```
34
-
35
- ## 📚 **[Complete Guide →](GETTING-STARTED.md)**
36
-
37
- ## Español
38
-
39
- Transforma tu idea en un proyecto listo para producción y documentado para IA en minutos (backend, frontend, fullstack, mobile o desktop).
40
-
41
- **Características:**
42
-
43
- - 🚀 Documentación profesional completa (Backend: 14 archivos, Frontend: 15 archivos, Mobile: 13 archivos, Desktop: 14 archivos, Fullstack: 30+ archivos)
44
- - 🧠 **Refinamiento Inteligente:** Detecta ambigüedad y te guía iterativamente hacia una descripción profesional.
45
- - ⚡ **Dos modos:** Interactivo (90-120 min, control total) o Auto-Sugerido (15-25 min, 6 preguntas)
46
- - 🌍 Soporte universal - 12 lenguajes, 60+ frameworks, 35+ ORMs
47
- - 🤖 Compatible with Claude, Copilot, Cursor, Gemini, Antigravity
48
- - 🔍 Detección inteligente para proyectos existentes (50-94% más rápido)
49
- - 🚀 **Modo Agente:** Los asistentes de IA ahora priorizan la ejecución proactiva para todos los comandos `/flow-`.
50
- - ⏱️ Ahorra 10-20 horas por proyecto
51
-
52
- **Inicio rápido:**
53
-
54
- **Requisitos:** Node.js ≥20.0.0
55
-
56
- ```bash
57
- npm install -g ai-flow-dev
58
- ai-flow init .
59
- # Luego en tu herramienta IA:
60
- # /flow-build - Para generar toda la documentación
61
- # /flow-work - Para comenzar a construir funcionalidades
62
- ```
63
-
64
- ## 📚 **[Guía Completa →](GETTING-STARTED.md)**
65
-
66
- ## Português
67
-
68
- Transforme sua ideia em um projeto pronto para produção e documentado para IA em minutos (backend, frontend, fullstack, mobile ou desktop).
69
- **Características:**
70
-
71
- - 🚀 Documentação profissional completa (Backend: 14 arquivos, Frontend: 15 arquivos, Mobile: 13 arquivos, Desktop: 14 arquivos, Fullstack: 30+ arquivos)
72
- - 🚀 **Modo Agente:** Os assistentes de IA agora priorizam a execução proativa para todos os comandos `/flow-`.
73
- - 🧠 **Refinamento Inteligente:** Detecta ambiguidade e guia você para uma descrição profissional.
74
- - ⚡ **Dois modos:** Interactivo (90-120 min, controle total) ou Auto-Sugestão (15-25 min, 6 perguntas)
75
- - 🌍 Suporte universal - 12 linguagens, 60+ frameworks, 35+ ORMs
76
- - 🤖 Compatível com Claude, Copilot, Cursor, Gemini, Antigravity
77
- - 🔍 Detecção inteligente para projetos existentes (50-94% mais rápido)
78
- - ⏱️ Economize 10-20 horas por projeto
79
-
80
- **Início Rápido:**
81
-
82
- **Requisitos:** Node.js ≥20.0.0
83
-
84
- ```bash
85
- npm install -g ai-flow-dev
86
- ai-flow init .
87
- # Em seguida, na sua ferramenta de IA:
88
- # /flow-build - Para gerar toda a documentação
89
- # /flow-work - Para começar a construir funcionalidades
90
- ```
91
-
92
- ## 📚 **[Guia Completo →](GETTING-STARTED.md)**
93
-
94
- ## 🎯 What is AI Flow?
95
-
96
- AI Flow is an interactive CLI tool that generates comprehensive professional documentation and provides an AI-powered development workflow throughout your project lifecycle (backend, frontend, fullstack, mobile, or desktop). It creates the foundation for AI-assisted development with any AI tool, from initial setup to feature development and maintenance.
97
-
98
- **The Problem:** Starting a project requires hours of documentation setup. Existing projects lack proper AI-ready documentation. Without proper docs, AI assistants work inefficiently.
99
- **The Solution:**
100
-
101
- - **Interactive Mode:** Full control, all questions (90-120 min new, 35-70 min existing)
102
- - **Smart Auto-Suggest Mode:** Only 6 critical questions, AI suggests the rest (15-25 min)
103
- - **Smart Detection:** Analyzes existing projects to pre-populate answers (50-60% faster)
104
-
105
- The result is interconnected documentation that guides AI assistants and human developers throughout your project lifecycle.
106
-
107
- ---
108
-
109
- - 🌍 **Universal Support** - 12 languages, 60+ frameworks, 35+ ORMs (98% coverage)
110
- - 🤖 **AI-Agnostic** - Claude, Copilot, Cursor, Gemini, Antigravity, any AI tool
111
- - 📚 **Professional Documentation** - Backend: 17 files, Frontend: 15 files, Mobile: 13 files, Desktop: 16 files, Fullstack: 30+ files
112
- - 🧠 **Smart Description Refinement** - AI detects vague inputs and helps you rich the context (WHO, WHAT, WHY).
113
- - ⚡ **Two Questionnaire Modes:**
114
- - **Interactive Mode:** Full control, all phases (90-120 min)
115
- - **Smart Auto-Suggest:** Only 6 critical questions, AI suggests best practices (15-25 min)
116
- - 🔍 **Smart 3-Layer Detection** - Analyzes existing projects in 15s-5min
117
- - 💾 **Intelligent Caching** - 0 seconds on re-runs with no changes
118
- - 🚀 **Agent Mode** - Immediate, proactive execution for all AI workflows
119
- - 💡 **Slash Commands** - Easy execution with `/flow-build`, `/flow-work`, `/flow-check`, `/flow-commit`
120
- - ⏱️ **Time Efficient** - Save 10-20 hours per project
121
-
122
- ---
123
-
124
- ## 📋 Prerequisites
125
-
126
- - **Node.js:** 20.0.0 or higher ([Download](https://nodejs.org/))
127
- - **npm:** Included with Node.js
128
-
129
- ---
130
-
131
- ## 📦 Installation
132
-
133
- ```bash
134
- npm install -g ai-flow-dev
135
- ```
136
-
137
- Or using uv (Python tool manager):
138
-
139
- ```bash
140
- uv tool install ai-flow-dev
141
- ```
142
-
143
- ## **Current version:** 2.7.0
144
-
145
- ## 🚀 Quick Start
146
-
147
- ```bash
148
- # 1. Create project folder
149
- mkdir my-awesome-project
150
- cd my-awesome-project
151
-
152
- # 2. Initialize AI Flow
153
- ai-flow init .
154
-
155
- # 3. Open your AI tool and run:
156
- /flow-build
157
- ```
158
-
159
- That's it! The AI will guide you through an interactive questionnaire to generate all documentation.
160
-
161
- ## **📚 For detailed tutorials, see [GETTING-STARTED.md](GETTING-STARTED.md)**
162
-
163
- ## 🛠️ CLI Commands
164
-
165
- ```bash
166
- ai-flow init [path] # Initialize project
167
- ai-flow check # Verify initialization
168
- ai-flow --version # Show version
169
- ai-flow --help # Show help
170
- ```
171
-
172
- **Example `check` output:**
173
-
174
- ```bash
175
- $ ai-flow check
176
-
177
- ✓ .ai-flow/core/config.json found
178
- ✓ AI tools configured: antigravity
179
- ✓ Project Type: Backend (backend)
180
- ✓ Documentation complete: 17 files
181
- ✓ Slash commands installed: .agent/workflows/
182
-
183
- ✅ All checks passed! Your project is ready for AI-assisted development.
184
- ```
185
-
186
- ### Common Flags
187
-
188
- ```bash
189
- --ai <tool> # claude, cursor, copilot, gemini, antigravity, all (interactive if omitted)
190
- --type <type> # backend, frontend, mobile, desktop, fullstack (interactive if omitted)
191
- --name <name> # Project name (interactive if omitted)
192
- --description <desc> # Project description (interactive if omitted)
193
- --verbose # Detailed logging (init only)
194
- --dry-run # Simulate without writing (init only)
195
- ```
196
-
197
- **Examples:**
198
-
199
- ```bash
200
- # Non-interactive mode (all flags provided)
201
- ai-flow init . --ai claude --type backend --name "My API" --description "REST API"
202
-
203
- # Interactive mode (will prompt for missing values)
204
- ai-flow init .
205
-
206
- # Hybrid mode (some flags, some prompts)
207
- ai-flow init . --ai claude
208
-
209
- # Specify project type directly
210
- ai-flow init . --type backend
211
-
212
- # Combine type with AI tool
213
- ai-flow init . --ai claude --type fullstack
214
-
215
- # Mobile project example
216
- ai-flow init . --ai claude --type mobile
217
-
218
- # Desktop project example (NetBeans/Eclipse)
219
- ai-flow init . --ai claude --type desktop
220
-
221
- # Enable verbose output (detailed logging) - only for init command
222
- ai-flow init . --verbose
223
-
224
- # Simulate initialization without writing files (dry-run)
225
- ai-flow init . --dry-run --verbose
226
-
227
- # Show detailed help with all commands and options
228
- ai-flow --help
229
-
230
- # Show help for specific command
231
- ai-flow init --help
232
- ai-flow check --help
233
- ```
234
-
235
- ---
236
-
237
- ## 🤖 AI Tool Support
238
-
239
- AI Flow works with any AI tool. Select during initialization:
240
-
241
- ```bash
242
- ai-flow init . --ai claude # Claude Code
243
- ai-flow init . --ai cursor # Cursor
244
- ai-flow init . --ai copilot # GitHub Copilot
245
- ai-flow init . --ai gemini # Gemini
246
- ai-flow init . --ai all # All tools (maximum compatibility)
247
- ai-flow init . --ai antigravity # Antigravity tool
248
- ```
249
-
250
- Each tool gets:
251
-
252
- - Tool-specific configuration files
253
- - Slash commands optimized for that tool
254
- - Integration with `AGENT.md` (universal config)
255
-
256
- **Slash command locations:**
257
-
258
- - **GitHub Copilot:** `.github/prompts/*.prompt.md`
259
- - **Claude:** `.claude/commands/*.md`
260
- - **Cursor:** `.cursor/commands/*.md`
261
- - **Gemini:** `.gemini/commands/*.md`
262
- - **Antigravity:** `.agent/workflows/*.md`
263
-
264
- ---
265
-
266
- ## 📋 Available Commands
267
-
268
- After initialization, use these slash commands in your AI tool:
269
-
270
- > **Note:** Command prefix may vary by AI tool. Examples use `/flow-` (GitHub Copilot), but Claude may use `/` alone, Cursor may use `@`, etc. Check your tool's documentation.
271
-
272
- **Backend Projects:** 22 prompts (/flow-build with phases 0-10, /flow-work, /flow-check, /flow-commit, /flow-docs-sync)
273
- **Frontend Projects:** 22 prompts (same structure tailored for frontend)
274
- **Mobile Projects:** 22 prompts (same structure tailored for mobile apps)
275
- **Fullstack Projects:** Combined backend + frontend commands
276
-
277
- **Documentation & Build:**
278
-
279
- - `/flow-build` - Flujo completo: todas las fases en orden (11 fases backend, 11 frontend/mobile/desktop)
280
- - `/flow-build fase N` - Ejecutar fase específica (ver lista de fases abajo)
281
- - `/flow-work` - Development orchestrator (feature, refactor, fix, resume)
282
- - `/flow-check` - Combined code review & testing workflow
283
- - `/flow-commit` - Atomic commits (Conventional Commits)
284
- - `/flow-docs-sync` - Update documentation when code changes
285
-
286
- **Fases disponibles (Backend):**
287
-
288
- - `/flow-build fase 0` - Context Discovery (solo proyectos existentes)
289
- - `/flow-build fase 1` - Discovery & Business
290
- - `/flow-build fase 2` - Data Architecture
291
- - `/flow-build fase 3` - System Architecture
292
- - `/flow-build fase 4` - Security & Authentication
293
- - `/flow-build fase 5` - Code Standards
294
- - `/flow-build fase 6` - Testing Strategy
295
- - `/flow-build fase 7` - Operations & Deployment
296
- - `/flow-build fase 8` - Project Setup & Final Documentation
297
- - `/flow-build fase 9` - Implementation Roadmap (opcional)
298
- - `/flow-build fase 10` - User Stories Generation (opcional, requiere Fase 9)
299
-
300
- **Fases disponibles (Frontend/Mobile/Desktop):**
301
-
302
- - `/flow-build fase 0` - Context Discovery (solo proyectos existentes)
303
- - `/flow-build fase 1` - Discovery & UX / Platform Selection
304
- - `/flow-build fase 2` - Components & Framework / Navigation
305
- - `/flow-build fase 3` - State Management
306
- - `/flow-build fase 4` - Styling & Design / Permissions
307
- - `/flow-build fase 5` - Code Standards
308
- - `/flow-build fase 6` - Testing Strategy
309
- - `/flow-build fase 7` - Performance & Deployment / Store Deployment
310
- - `/flow-build fase 8` - Project Setup & Final Documentation
311
- - `/flow-build fase 9` - Implementation Roadmap (opcional)
312
- - `/flow-build fase 10` - User Stories Generation (opcional)
313
-
314
- **Workflows (All project types):**
315
-
316
- - `/flow-work` - **Unified orchestrator** for Features/Refactors/Fixes with smart detection, automatic completion tracking, and consolidated planning
317
- - `/flow-check` - **Combined validation**: Tests + Code Review in one command
318
- - `/flow-commit` - Automate commits with Conventional Commits (3-5 min)
319
- - `/flow-docs-sync` - **Sync documentation** when code changes occur
320
-
321
- > **Note:** `/flow-work` automatically marks tasks as complete in `planning/roadmap.md` and user story DoD checklists when implementation finishes. It generates a consolidated `work.md` file for efficient planning and context management.
322
-
323
- ## **📚 See [GETTING-STARTED.md](GETTING-STARTED.md) for complete command reference**
324
-
325
- ---
326
-
327
- ## 📁 Project Structure
328
-
329
- AI Flow organizes your project with clear separation of concerns:
330
-
331
- ### Documentation & Specifications
332
-
333
- - **`docs/`** - Descriptive documentation (WHAT the project IS)
334
- - `architecture.md` - System architecture and design patterns
335
- - `data-model.md` - Entities, relationships, database schema
336
- - `api.md` - Available endpoints and contracts
337
- - `testing.md` - Testing strategy and guidelines
338
-
339
- - **`specs/`** - Technical specifications (HOW to IMPLEMENT)
340
- - `security.md` - Security rules and constraints (MUST/NEVER)
341
- - `configuration.md` - Environment variables and settings
342
-
343
- ### Planning & Requirements
344
-
345
- - **`planning/`** - Requirements and roadmap (WHAT to DO)
346
- - `roadmap.md` - Technical implementation roadmap with Story Points
347
- - `user-stories/` - Agile user stories with acceptance criteria
348
-
349
- ### Development State
350
-
351
- - **`.ai-flow/`** - AI workflow state (temporary, can be gitignored)
352
- - `work/` - Active development tasks
353
- - `archive/` - Completed tasks (organized by month)
354
-
355
- > **Note on Cache Directory:**
356
- >
357
- > **In projects using AI Flow:**
358
- >
359
- > - Cache is stored in `.ai-flow/cache/` (analysis data for your project)
360
- > - Contains: `docs-analysis.json`, `audit-data.json`, `docs-snapshot.json`
361
- >
362
- > **In the AI Flow repository itself:**
363
- >
364
- > - Cache is stored in `cache/` at root (self-analysis data)
365
- > - Used by `/flow3-docs` to track documentation accuracy
366
- >
367
- > These are two different caches with different purposes.
368
-
369
- ## 💡 How It Works
370
-
371
- 1. **Smart Detection** - Analyzes existing projects in 3 layers (15s to 5min)
372
- 2. **Interactive Questionnaire** - Guides you through 8-9 phases (choose mode)
373
- 3. **Template Generation** - Creates 13-17 professional documents per project type
374
- 4. **Implementation Roadmap** - Optional Phase 9 generates Story Point estimates
375
- 5. **AI Integration** - Configures your AI tool with project context
376
- 6. **Slash Command Setup** - Installs prompts to tool-specific paths (.github/prompts/, .claude/commands/, etc.)
377
-
378
- **For existing projects:**
379
-
380
- - Layer 0: Cache check (0-5s)
381
- - Layer 1: Metadata scan (10-20s)
382
- - Layer 2: Structural analysis (30-90s)
383
- - Layer 3: Deep analysis (1-5min, optional)
384
-
385
- **Benefits:**
386
-
387
- - 50-94% faster for existing projects
388
- - 40-60% of answers pre-filled
389
- - Intelligent caching (0s re-runs)
390
-
391
- ---
392
-
393
- ## 🎯 Generated Documentation
394
-
395
- **Backend** (17 files): AGENT.md, ai-instructions.md, copilot-instructions.md, project-brief.md, README.md, plus 8 docs (in docs/) and 4 specs/configs.
396
-
397
- **Frontend** (15 files): AGENT.md, ai-instructions.md, project-brief.md, plus 12 technical docs/specs.
398
-
399
- **Mobile** (13 files): AGENT.md, ai-instructions.md, project-brief.md, plus 10 technical docs/specs.
400
-
401
- **Fullstack** (30+ files): Combined Backend + Frontend documentation structures.
402
-
403
- **Slash Commands/Prompts** (72 total):
404
-
405
- - Backend: 22 prompts (/flow-build with phases 0-10, /flow-work variants, /flow-check, /flow-commit, /flow-docs-sync)
406
- - Frontend: 22 prompts (same structure tailored for frontend)
407
- - Mobile: 22 prompts (same structure tailored for mobile apps)
408
- - Shared: 6 prompts (task-format.md, story-points.md, task-summary-template.md, etc.)
409
- - **Total: 72 prompts** across all project types
410
-
411
- Each project type gets workflow commands optimized for its technology stack.
412
-
413
- ### 📁 Generated Structure
414
-
415
- After running `ai-flow init`, your project will have:
416
-
417
- ```
418
- project-root/
419
- ├── AGENT.md # Universal AI entry point (all tools)
420
- ├── README.md # Project documentation
421
- ├── docs/ # Technical documentation
422
- ├── architecture.md
423
- ├── api.md # (Backend only)
424
- ├── database.md # (Backend only)
425
- │ ├── deployment.md
426
- │ ├── security.md
427
- └── ...
428
- ├── specs/ # Specifications
429
- │ ├── features.md
430
- ├── requirements.md
431
- │ └── ...
432
- ├── .ai-flow/ # Internal metadata
433
- └── core/
434
- └── config.json # AI Flow configuration
435
- ├── .github/prompts/ # GitHub Copilot commands
436
- ├── .claude/commands/ # Claude commands (if selected)
437
- ├── .cursor/commands/ # Cursor commands (if selected)
438
- ├── .gemini/commands/ # Gemini commands (if selected)
439
- ├── .agent/workflows/ # Antigravity commands (if selected)
440
- └── ... (your project files)
441
- ```
442
-
443
- **Key locations:**
444
-
445
- - Documentation lives at **project root** (`docs/`, `specs/`, `AGENT.md`)
446
- - `.ai-flow/` is internal metadata (don't edit manually)
447
- - Slash commands are tool-specific (`.github/prompts/`, `.claude/commands/`, etc.)
448
-
449
- ---
450
-
451
- ## 🌍 Supported Languages & Frameworks
452
-
453
- AI Flow provides **universal support** with automatic detection for 98% of the market:
454
-
455
- ### Languages Supported (12)
456
-
457
- | Language | Market Share | Frameworks | ORMs | Status |
458
- | ---------------------- | ------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------- | ------- |
459
- | **Node.js/TypeScript** | ~35% | NestJS, Express, Fastify, Koa, Hapi, AdonisJS, Next.js, Remix, tRPC | Prisma, TypeORM, Sequelize, Mongoose, Drizzle, MikroORM, Knex | ✅ Full |
460
- | **Python** | ~25% | FastAPI, Django, Django REST Framework, Flask, Tornado, Sanic, Starlette | SQLAlchemy, Django ORM, Tortoise ORM, Peewee, SQLModel | ✅ Full |
461
- | **PHP** | ~15% | Laravel, Symfony, CodeIgniter, Slim, Lumen, Yii | Eloquent, Doctrine, Propel | Full |
462
- | **Java** | ~15% | Spring Boot, Micronaut, Quarkus, Vert.x, Dropwizard | Hibernate/JPA, MyBatis, jOOQ | ✅ Full |
463
- | **C#/.NET** | ~8% | ASP.NET Core, Minimal APIs, Nancy | Entity Framework Core, Dapper, NHibernate | ✅ Full |
464
- | **Go** | ~5% | Gin, Echo, Fiber, Chi, Buffalo | GORM, Ent, sqlx, sqlc | ✅ Full |
465
- | **Ruby** | ~3% | Ruby on Rails, Sinatra, Hanami, Grape | ActiveRecord, Sequel, ROM | ✅ Full |
466
- | **Kotlin** | ~2% | Ktor, Spring Boot, Javalin, http4k | Exposed, Hibernate | ✅ Full |
467
- | **Rust** | ~1% | Actix-web, Rocket, Axum, Warp | Diesel, SeaORM, sqlx | ✅ Full |
468
- | **Elixir** | <1% | Phoenix | Ecto | ✅ Full |
469
- | **Scala** | <1% | Play Framework, Akka HTTP | Slick, Quill | ✅ Full |
470
- | **Swift** | <1% | Vapor | Fluent | ✅ Full |
471
-
472
- ## **See [GETTING-STARTED.md](GETTING-STARTED.md) for automatic detection details and examples.**
473
-
474
- ## 🎓 Why Use AI Flow?
475
-
476
- **Without AI Flow:**
477
-
478
- - ⏱️ 10-20 hours creating docs manually
479
- - 🤔 AI assistants lack context, make assumptions
480
- - 🐛 More bugs due to unclear standards
481
-
482
- **With AI Flow:**
483
-
484
- - ⏱️ 90-120 min (new) or 35-70 min (existing)
485
- - 🤖 AI assistants work with full context and continuous workflow
486
- - ✅ Consistent quality, fewer bugs
487
- - 💾 Save 10-20 hours per project
488
-
489
- ---
490
-
491
- ## 📚 Documentation Philosophy
492
-
493
- AI Flow follows: **Documentation as Executable Code**
494
-
495
- - Documents guide AI assistants (like config files guide compilers)
496
- - `AGENT.md` is the universal entry point
497
- - All documents are interconnected
498
- - Documents evolve with your project
499
- - Single source of truth for all AI tools
500
-
501
- ---
502
-
503
- ## 🎯 Who Should Use This?
504
-
505
- **Perfect for:**
506
-
507
- - ✅ Backend/frontend/mobile/desktop developers starting new projects
508
- - ✅ Teams with existing codebases needing AI-ready documentation
509
- - ✅ Projects requiring comprehensive documentation
510
- - ✅ Teams adopting AI-assisted development
511
- - ✅ Multi-language teams (12 languages supported)
512
-
513
- **Not ideal for:**
514
-
515
- - ❌ Projects with zero documentation needs
516
- - Quick prototypes that won't be maintained
517
-
518
- ---
519
-
520
- ## 🚀 Roadmap
521
-
522
- - [x] Backend, frontend, mobile, desktop, fullstack support ✅
523
- - [ ] Template customization
524
- - [ ] VS Code extension
525
- - [ ] Interactive web UI
526
-
527
- ---
528
-
529
- ## 🛠️ Troubleshooting
530
-
531
- **Common issues:**
532
-
533
- - Node.js version must be ≥20.0.0
534
- - Check folder permissions if CLI can't write files
535
- - Verify slash command files exist for your AI tool:
536
- - **GitHub Copilot:** `.github/prompts/*.prompt.md`
537
- - **Claude:** `.claude/commands/*.md`
538
- - **Cursor:** `.cursor/commands/*.md`
539
- - **Gemini:** `.gemini/commands/*.md`
540
- - **Antigravity:** `.agent/workflows/*.md`
541
- - If missing, re-run: `ai-flow init . --ai <your-tool>`
542
-
543
- **📚 See [GETTING-STARTED.md](GETTING-STARTED.md#troubleshooting) for detailed troubleshooting guide**
544
-
545
- ## 🤝 Contributing
546
-
547
- ## We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
548
-
549
- ## 📝 License
550
-
551
- ## MIT License - See [LICENSE](LICENSE) for details.
552
-
553
- ## 💬 Support
554
-
555
- - **Issues:** [GitHub Issues](https://github.com/victorvelazquez/ai-flow/issues)
556
- - **Email:** support@ai-flow.dev (if applicable)
557
-
558
- ---
559
-
560
- ## 🙏 Acknowledgments
561
-
562
- - Inspired by [GitHub Spec-Kit](https://github.com/github/spec-kit)
563
- - Built for the AI-assisted development era
564
- - Community feedback and contributions
565
-
566
- ---
567
-
568
- **Transform your idea into a production-ready project with AI Flow** 🚀
569
-
570
- **Made with ❤️ for the developer community**
1
+ # AI Flow
2
+
3
+ [![CI Status](https://github.com/victorvelazquez/ai-flow/actions/workflows/nodejs.yml/badge.svg)](https://github.com/victorvelazquez/ai-flow/actions/workflows/nodejs.yml)
4
+
5
+ ## English
6
+
7
+ Transform your idea into a production-ready, AI-documented project (backend, frontend, fullstack, mobile, or desktop) in minutes.
8
+
9
+ AI Flow is an interactive CLI that creates comprehensive professional documentation and provides an AI-powered development workflow from idea to production. Compatible with Claude, Copilot, Cursor, Gemini, Antigravity, and any AI assistant.
10
+
11
+ **Key Features:**
12
+
13
+ - 🚀 Complete professional documentation (Backend: 17 files, Frontend: 15 files, Mobile: 13 files, Desktop: 16 files, Fullstack: 30+ files)
14
+ - 🧠 **Smart Description Refinement:** Detects ambiguity and iteratively guides you to a professional project definition.
15
+ - ⚡ **Two modes:** Interactive (90-120 min, full control) or Smart Auto-Suggest (15-25 min, 6 questions)
16
+ - 🌍 Universal support - 12 languages, 60+ frameworks, 35+ ORMs (98% coverage)
17
+ - 🤖 Multi-AI support with slash commands
18
+ - 🔍 Smart 3-layer detection for existing projects (50-94% faster)
19
+ - 🎯 **Smart Skip Logic:** Intelligently skips documentation phases for existing projects (15-20 min vs 90 min for ≥95% consistency).
20
+ - 🚀 **Agent Mode Enforcement:** AI assistants now prioritize proactive tool usage and immediate execution for all `/flow-` commands (No more redundant planning).
21
+ - ⏱️ Save 10-20 hours per project
22
+
23
+ **Quick Start:**
24
+
25
+ **Requirements:** Node.js ≥20.0.0
26
+
27
+ ```bash
28
+ npm install -g ai-flow-dev
29
+ ai-flow init .
30
+ # Then open your AI tool and run:
31
+ # /flow-build - To generate all documentation
32
+ # /flow-work - To start building features
33
+ ```
34
+
35
+ ## 📚 **[Complete Guide →](GETTING-STARTED.md)**
36
+
37
+ ## Español
38
+
39
+ Transforma tu idea en un proyecto listo para producción y documentado para IA en minutos (backend, frontend, fullstack, mobile o desktop).
40
+
41
+ **Características:**
42
+
43
+ - 🚀 Documentación profesional completa (Backend: 14 archivos, Frontend: 15 archivos, Mobile: 13 archivos, Desktop: 14 archivos, Fullstack: 30+ archivos)
44
+ - 🧠 **Refinamiento Inteligente:** Detecta ambigüedad y te guía iterativamente hacia una descripción profesional.
45
+ - ⚡ **Dos modos:** Interactivo (90-120 min, control total) o Auto-Sugerido (15-25 min, 6 preguntas)
46
+ - 🌍 Soporte universal - 12 lenguajes, 60+ frameworks, 35+ ORMs
47
+ - 🤖 Compatible with Claude, Copilot, Cursor, Gemini, Antigravity
48
+ - 🔍 Detección inteligente para proyectos existentes (50-94% más rápido)
49
+ - 🚀 **Modo Agente:** Los asistentes de IA ahora priorizan la ejecución proactiva para todos los comandos `/flow-`.
50
+ - ⏱️ Ahorra 10-20 horas por proyecto
51
+
52
+ **Inicio rápido:**
53
+
54
+ **Requisitos:** Node.js ≥20.0.0
55
+
56
+ ```bash
57
+ npm install -g ai-flow-dev
58
+ ai-flow init .
59
+ # Luego en tu herramienta IA:
60
+ # /flow-build - Para generar toda la documentación
61
+ # /flow-work - Para comenzar a construir funcionalidades
62
+ ```
63
+
64
+ ## 📚 **[Guía Completa →](GETTING-STARTED.md)**
65
+
66
+ ## Português
67
+
68
+ Transforme sua ideia em um projeto pronto para produção e documentado para IA em minutos (backend, frontend, fullstack, mobile ou desktop).
69
+ **Características:**
70
+
71
+ - 🚀 Documentação profissional completa (Backend: 14 arquivos, Frontend: 15 arquivos, Mobile: 13 arquivos, Desktop: 14 arquivos, Fullstack: 30+ arquivos)
72
+ - 🚀 **Modo Agente:** Os assistentes de IA agora priorizam a execução proativa para todos os comandos `/flow-`.
73
+ - 🧠 **Refinamento Inteligente:** Detecta ambiguidade e guia você para uma descrição profissional.
74
+ - ⚡ **Dois modos:** Interactivo (90-120 min, controle total) ou Auto-Sugestão (15-25 min, 6 perguntas)
75
+ - 🌍 Suporte universal - 12 linguagens, 60+ frameworks, 35+ ORMs
76
+ - 🤖 Compatível com Claude, Copilot, Cursor, Gemini, Antigravity
77
+ - 🔍 Detecção inteligente para projetos existentes (50-94% mais rápido)
78
+ - ⏱️ Economize 10-20 horas por projeto
79
+
80
+ **Início Rápido:**
81
+
82
+ **Requisitos:** Node.js ≥20.0.0
83
+
84
+ ```bash
85
+ npm install -g ai-flow-dev
86
+ ai-flow init .
87
+ # Em seguida, na sua ferramenta de IA:
88
+ # /flow-build - Para gerar toda a documentação
89
+ # /flow-work - Para começar a construir funcionalidades
90
+ ```
91
+
92
+ ## 📚 **[Guia Completo →](GETTING-STARTED.md)**
93
+
94
+ ## 🎯 What is AI Flow?
95
+
96
+ AI Flow is an interactive CLI tool that generates comprehensive professional documentation and provides an AI-powered development workflow throughout your project lifecycle (backend, frontend, fullstack, mobile, or desktop). It creates the foundation for AI-assisted development with any AI tool, from initial setup to feature development and maintenance.
97
+
98
+ **The Problem:** Starting a project requires hours of documentation setup. Existing projects lack proper AI-ready documentation. Without proper docs, AI assistants work inefficiently.
99
+ **The Solution:**
100
+
101
+ - **Interactive Mode:** Full control, all questions (90-120 min new, 35-70 min existing)
102
+ - **Smart Auto-Suggest Mode:** Only 6 critical questions, AI suggests the rest (15-25 min)
103
+ - **Smart Detection:** Analyzes existing projects to pre-populate answers (50-60% faster)
104
+
105
+ The result is interconnected documentation that guides AI assistants and human developers throughout your project lifecycle.
106
+
107
+ ---
108
+
109
+ - 🌍 **Universal Support** - 12 languages, 60+ frameworks, 35+ ORMs (98% coverage)
110
+ - 🤖 **AI-Agnostic** - Claude, Copilot, Cursor, Gemini, Antigravity, any AI tool
111
+ - 📚 **Professional Documentation** - Backend: 14 files, Frontend: 15 files, Mobile: 13 files, Desktop: 14 files, Fullstack: 30+ files
112
+ - 🧠 **Smart Description Refinement** - AI detects vague inputs and helps you rich the context (WHO, WHAT, WHY).
113
+ - ⚡ **Two Questionnaire Modes:**
114
+ - **Interactive Mode:** Full control, all phases (90-120 min)
115
+ - **Smart Auto-Suggest:** Only 6 critical questions, AI suggests best practices (15-25 min)
116
+ - 🔍 **Smart 3-Layer Detection** - Analyzes existing projects in 15s-5min
117
+ - 💾 **Intelligent Caching** - 0 seconds on re-runs with no changes
118
+ - 🚀 **Agent Mode** - Immediate, proactive execution for all AI workflows
119
+ - 💡 **Slash Commands** - Easy execution with `/flow-build`, `/flow-work`, `/flow-check`, `/flow-commit`, `/flow-finish`, `/flow-release`
120
+ - ⏱️ **Time Efficient** - Save 10-20 hours per project
121
+
122
+ ---
123
+
124
+ ## 📋 Prerequisites
125
+
126
+ - **Node.js:** 20.0.0 or higher ([Download](https://nodejs.org/))
127
+ - **npm:** Included with Node.js
128
+
129
+ ---
130
+
131
+ ## 📦 Installation
132
+
133
+ ```bash
134
+ npm install -g ai-flow-dev
135
+ ```
136
+
137
+ Or using uv (Python tool manager):
138
+
139
+ ```bash
140
+ uv tool install ai-flow-dev
141
+ ```
142
+
143
+ ## **Current version:** 2.7.0
144
+
145
+ ## 🚀 Quick Start
146
+
147
+ ```bash
148
+ # 1. Create project folder
149
+ mkdir my-awesome-project
150
+ cd my-awesome-project
151
+
152
+ # 2. Initialize AI Flow
153
+ ai-flow init .
154
+
155
+ # 3. Open your AI tool and run:
156
+ /flow-build
157
+ ```
158
+
159
+ That's it! The AI will guide you through an interactive questionnaire to generate all documentation.
160
+
161
+ ## **📚 For detailed tutorials, see [GETTING-STARTED.md](GETTING-STARTED.md)**
162
+
163
+ ## 🛠️ CLI Commands
164
+
165
+ ```bash
166
+ ai-flow init [path] # Initialize project
167
+ ai-flow check # Verify initialization
168
+ ai-flow --version # Show version
169
+ ai-flow --help # Show help
170
+ ```
171
+
172
+ **Example `check` output:**
173
+
174
+ ```bash
175
+ $ ai-flow check
176
+
177
+ ✓ .ai-flow/core/config.json found
178
+ ✓ AI tools configured: antigravity
179
+ ✓ Project Type: Backend (backend)
180
+ ✓ Documentation complete: 17 files
181
+ ✓ Slash commands installed: .agent/workflows/
182
+
183
+ ✅ All checks passed! Your project is ready for AI-assisted development.
184
+ ```
185
+
186
+ ### Common Flags
187
+
188
+ ```bash
189
+ --ai <tool> # claude, cursor, copilot, gemini, antigravity, all (interactive if omitted)
190
+ --type <type> # backend, frontend, mobile, desktop, fullstack (interactive if omitted)
191
+ --name <name> # Project name (interactive if omitted)
192
+ --description <desc> # Project description (interactive if omitted)
193
+ --dry-run # Simulate without writing (init only)
194
+ ```
195
+
196
+ **Examples:**
197
+
198
+ ```bash
199
+ # Non-interactive mode (all flags provided)
200
+ ai-flow init . --ai claude --type backend --name "My API" --description "REST API"
201
+
202
+ # Interactive mode (will prompt for missing values)
203
+ ai-flow init .
204
+
205
+ # Hybrid mode (some flags, some prompts)
206
+ ai-flow init . --ai claude
207
+
208
+ # Specify project type directly
209
+ ai-flow init . --type backend
210
+
211
+ # Combine type with AI tool
212
+ ai-flow init . --ai claude --type fullstack
213
+
214
+ # Mobile project example
215
+ ai-flow init . --ai claude --type mobile
216
+
217
+ # Desktop project example (NetBeans/Eclipse)
218
+ ai-flow init . --ai claude --type desktop
219
+
220
+ # Simulate initialization without writing files (dry-run)
221
+ ai-flow init . --dry-run
222
+
223
+ # Show detailed help with all commands and options
224
+ ai-flow --help
225
+
226
+ # Show help for specific command
227
+ ai-flow init --help
228
+ ai-flow check --help
229
+ ```
230
+
231
+ ---
232
+
233
+ ## 🤖 AI Tool Support
234
+
235
+ AI Flow works with any AI tool. Select during initialization:
236
+
237
+ ```bash
238
+ ai-flow init . --ai claude # Claude Code
239
+ ai-flow init . --ai cursor # Cursor
240
+ ai-flow init . --ai copilot # GitHub Copilot
241
+ ai-flow init . --ai gemini # Gemini
242
+ ai-flow init . --ai all # All tools (maximum compatibility)
243
+ ai-flow init . --ai antigravity # Antigravity tool
244
+ ```
245
+
246
+ Each tool gets:
247
+
248
+ - Tool-specific configuration files
249
+ - Slash commands optimized for that tool
250
+ - Integration with `AGENT.md` (universal config)
251
+
252
+ **Slash command locations:**
253
+
254
+ - **GitHub Copilot:** `.github/prompts/*.prompt.md`
255
+ - **Claude:** `.claude/commands/*.md`
256
+ - **Cursor:** `.cursor/commands/*.md`
257
+ - **Gemini:** `.gemini/commands/*.md`
258
+ - **Antigravity:** `.agent/workflows/*.md`
259
+
260
+ ---
261
+
262
+ ## 📋 Available Commands
263
+
264
+ After initialization, use these slash commands in your AI tool:
265
+
266
+ > **Note:** Command prefix may vary by AI tool. Examples use `/flow-` (GitHub Copilot), but Claude may use `/` alone, Cursor may use `@`, etc. Check your tool's documentation.
267
+
268
+ **Backend Projects:** 24 prompts (/flow-build with phases 0-10, /flow-work, /flow-check, /flow-commit, /flow-finish, /flow-docs-sync, /flow-release)
269
+ **Frontend Projects:** 25 prompts (same structure tailored for frontend)
270
+ **Mobile Projects:** 25 prompts (same structure tailored for mobile apps)
271
+ **Desktop Projects:** 24 prompts (same structure tailored for desktop apps)
272
+ **Fullstack Projects:** Combined backend + frontend commands
273
+
274
+ **Documentation & Build:**
275
+
276
+ - `/flow-build` - Flujo completo: todas las fases en orden (11 fases backend, 11 frontend/mobile/desktop)
277
+ - `/flow-build fase N` - Ejecutar fase específica (ver lista de fases abajo)
278
+ - `/flow-work` - Development orchestrator (feature, refactor, fix, resume)
279
+ - `/flow-check` - Combined code review & testing workflow
280
+ - `/flow-commit` - Atomic commits (Conventional Commits)
281
+ - `/flow-finish` - Finalize work: archive, generate PR/Jira descriptions with AI, push
282
+ - `/flow-docs-sync` - Update documentation when code changes
283
+ - `/flow-release` - Semantic versioning automation with Git tags and Swagger UI updates
284
+
285
+ **Fases disponibles (Backend):**
286
+
287
+ - `/flow-build fase 0` - Context Discovery (solo proyectos existentes)
288
+ - `/flow-build fase 1` - Discovery & Business
289
+ - `/flow-build fase 2` - Data Architecture
290
+ - `/flow-build fase 3` - System Architecture
291
+ - `/flow-build fase 4` - Security & Authentication
292
+ - `/flow-build fase 5` - Code Standards
293
+ - `/flow-build fase 6` - Testing Strategy
294
+ - `/flow-build fase 7` - Operations & Deployment
295
+ - `/flow-build fase 8` - Project Setup & Final Documentation
296
+ - `/flow-build fase 9` - Implementation Roadmap (opcional)
297
+ - `/flow-build fase 10` - User Stories Generation (opcional, requiere Fase 9)
298
+
299
+ **Fases disponibles (Frontend/Mobile/Desktop):**
300
+
301
+ - `/flow-build fase 0` - Context Discovery (solo proyectos existentes)
302
+ - `/flow-build fase 1` - Discovery & UX / Platform Selection
303
+ - `/flow-build fase 2` - Components & Framework / Navigation
304
+ - `/flow-build fase 3` - State Management
305
+ - `/flow-build fase 4` - Styling & Design / Permissions
306
+ - `/flow-build fase 5` - Code Standards
307
+ - `/flow-build fase 6` - Testing Strategy
308
+ - `/flow-build fase 7` - Performance & Deployment / Store Deployment
309
+ - `/flow-build fase 8` - Project Setup & Final Documentation
310
+ - `/flow-build fase 9` - Implementation Roadmap (opcional)
311
+ - `/flow-build fase 10` - User Stories Generation (opcional)
312
+
313
+ **Workflows (All project types):**
314
+
315
+ - `/flow-work` - **Development orchestrator** for Features/Refactors/Fixes with smart detection, automatic completion tracking, and consolidated planning. Updates source documentation (roadmap/user stories), then guides you to run `/flow-finish`.
316
+ - `/flow-check` - **Combined validation**: Tests + Code Review in one command
317
+ - `/flow-commit` - Automate commits with Conventional Commits (3-5 min)
318
+ - `/flow-finish` - **Finalization workflow**: Smart validation (reuses /flow-check results), work archiving, AI-powered PR/Jira descriptions (~1200 tokens), optional push. Separate from `/flow-work` for better modularity.
319
+ - `/flow-docs-sync` - **Sync documentation** when code changes occur
320
+ - `/flow-release` - **Version release automation**: Semantic versioning, Git tags, Swagger UI updates, CHANGELOG generation
321
+
322
+ > **Architecture:** `/flow-work` focuses on development (planning → implementation → source docs update), while `/flow-finish` handles finalization (validation → archiving → summaries → push). This separation follows Unix philosophy: one tool, one responsibility. At the end of `/flow-work`, you get an interactive prompt to run `/flow-finish` immediately or handle finalization manually.
323
+
324
+ ## **📚 See [GETTING-STARTED.md](GETTING-STARTED.md) for complete command reference**
325
+
326
+ ---
327
+
328
+ ## 📁 Project Structure
329
+
330
+ AI Flow organizes your project with clear separation of concerns:
331
+
332
+ ### Documentation & Specifications
333
+
334
+ - **`docs/`** - Descriptive documentation (WHAT the project IS)
335
+ - `architecture.md` - System architecture and design patterns
336
+ - `data-model.md` - Entities, relationships, database schema
337
+ - `api.md` - Available endpoints and contracts
338
+ - `testing.md` - Testing strategy and guidelines
339
+
340
+ - **`specs/`** - Technical specifications (HOW to IMPLEMENT)
341
+ - `security.md` - Security rules and constraints (MUST/NEVER)
342
+ - `configuration.md` - Environment variables and settings
343
+
344
+ ### Planning & Requirements
345
+
346
+ - **`planning/`** - Requirements and roadmap (WHAT to DO)
347
+ - `roadmap.md` - Technical implementation roadmap with Story Points
348
+ - `user-stories/` - Agile user stories with acceptance criteria
349
+
350
+ ### Development State
351
+
352
+ - **`.ai-flow/`** - AI workflow state (temporary, can be gitignored)
353
+ - `work/` - Active development tasks
354
+ - `archive/` - Completed tasks (organized by month)
355
+
356
+ > **Note on Cache Directory:**
357
+ >
358
+ > **In projects using AI Flow:**
359
+ >
360
+ > - Cache is stored in `.ai-flow/cache/` (analysis data for your project)
361
+ > - Contains: `docs-analysis.json`, `audit-data.json`, `docs-snapshot.json`
362
+ >
363
+ > **In the AI Flow repository itself:**
364
+ >
365
+ > - Cache is stored in `cache/` at root (self-analysis data)
366
+ > - Used by `/flow3-docs` to track documentation accuracy
367
+ >
368
+ > These are two different caches with different purposes.
369
+
370
+ ## 💡 How It Works
371
+
372
+ 1. **Smart Detection** - Analyzes existing projects in 3 layers (15s to 5min)
373
+ 2. **Interactive Questionnaire** - Guides you through 8-9 phases (choose mode)
374
+ 3. **Template Generation** - Creates 13-17 professional documents per project type
375
+ 4. **Implementation Roadmap** - Optional Phase 9 generates Story Point estimates
376
+ 5. **AI Integration** - Configures your AI tool with project context
377
+ 6. **Slash Command Setup** - Installs prompts to tool-specific paths (.github/prompts/, .claude/commands/, etc.)
378
+
379
+ **For existing projects:**
380
+
381
+ - Layer 0: Cache check (0-5s)
382
+ - Layer 1: Metadata scan (10-20s)
383
+ - Layer 2: Structural analysis (30-90s)
384
+ - Layer 3: Deep analysis (1-5min, optional)
385
+
386
+ **Benefits:**
387
+
388
+ - 50-94% faster for existing projects
389
+ - 40-60% of answers pre-filled
390
+ - Intelligent caching (0s re-runs)
391
+
392
+ ---
393
+
394
+ ## 🎯 Generated Documentation
395
+
396
+ **Backend** (14 files): AGENT.md, ai-instructions.md, copilot-instructions.md, project-brief.md, README.md, plus 9 technical docs/specs.
397
+
398
+ **Frontend** (15 files): AGENT.md, ai-instructions.md, project-brief.md, plus 12 technical docs/specs.
399
+
400
+ **Mobile** (13 files): AGENT.md, ai-instructions.md, project-brief.md, plus 10 technical docs/specs.
401
+
402
+ **Desktop** (14 files): AGENT.md, ai-instructions.md, copilot-instructions.md, project-brief.md, README.md, plus 9 technical docs/specs.
403
+
404
+ **Fullstack** (30+ files): Combined Backend + Frontend documentation structures.
405
+
406
+ **Slash Commands/Prompts** (98 total):
407
+
408
+ - Backend: 24 prompts (/flow-build with phases 0-10, /flow-work variants, /flow-check, /flow-commit, /flow-finish, /flow-docs-sync, /flow-release)
409
+ - Frontend: 25 prompts (same structure tailored for frontend + /flow-work-api + /flow-finish + /flow-release)
410
+ - Mobile: 25 prompts (same structure tailored for mobile apps + /flow-work-api + /flow-finish + /flow-release)
411
+ - Desktop: 24 prompts (same structure tailored for desktop apps + /flow-finish + /flow-release)
412
+ - **Total: 98 prompts** across all project types
413
+
414
+ Each project type gets workflow commands optimized for its technology stack.
415
+
416
+ ### 📁 Generated Structure
417
+
418
+ After running `ai-flow init`, your project will have:
419
+
420
+ ```
421
+ project-root/
422
+ ├── AGENT.md # Universal AI entry point (all tools)
423
+ ├── README.md # Project documentation
424
+ ├── docs/ # Technical documentation
425
+ │ ├── architecture.md
426
+ │ ├── api.md # (Backend only)
427
+ ├── database.md # (Backend only)
428
+ ├── deployment.md
429
+ │ ├── security.md
430
+ └── ...
431
+ ├── specs/ # Specifications
432
+ ├── features.md
433
+ ├── requirements.md
434
+ └── ...
435
+ ├── .ai-flow/ # Internal metadata
436
+ │ └── core/
437
+ │ └── config.json # AI Flow configuration
438
+ ├── .github/prompts/ # GitHub Copilot commands
439
+ ├── .claude/commands/ # Claude commands (if selected)
440
+ ├── .cursor/commands/ # Cursor commands (if selected)
441
+ ├── .gemini/commands/ # Gemini commands (if selected)
442
+ ├── .agent/workflows/ # Antigravity commands (if selected)
443
+ └── ... (your project files)
444
+ ```
445
+
446
+ **Key locations:**
447
+
448
+ - Documentation lives at **project root** (`docs/`, `specs/`, `AGENT.md`)
449
+ - `.ai-flow/` is internal metadata (don't edit manually)
450
+ - Slash commands are tool-specific (`.github/prompts/`, `.claude/commands/`, etc.)
451
+
452
+ ---
453
+
454
+ ## 🌍 Supported Languages & Frameworks
455
+
456
+ AI Flow provides **universal support** with automatic detection for 98% of the market:
457
+
458
+ ### Languages Supported (12)
459
+
460
+ | Language | Market Share | Frameworks | ORMs | Status |
461
+ | ---------------------- | ------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------- | ------- |
462
+ | **Node.js/TypeScript** | ~35% | NestJS, Express, Fastify, Koa, Hapi, AdonisJS, Next.js, Remix, tRPC | Prisma, TypeORM, Sequelize, Mongoose, Drizzle, MikroORM, Knex | ✅ Full |
463
+ | **Python** | ~25% | FastAPI, Django, Django REST Framework, Flask, Tornado, Sanic, Starlette | SQLAlchemy, Django ORM, Tortoise ORM, Peewee, SQLModel | ✅ Full |
464
+ | **PHP** | ~15% | Laravel, Symfony, CodeIgniter, Slim, Lumen, Yii | Eloquent, Doctrine, Propel | ✅ Full |
465
+ | **Java** | ~15% | Spring Boot, Micronaut, Quarkus, Vert.x, Dropwizard | Hibernate/JPA, MyBatis, jOOQ | ✅ Full |
466
+ | **C#/.NET** | ~8% | ASP.NET Core, Minimal APIs, Nancy | Entity Framework Core, Dapper, NHibernate | ✅ Full |
467
+ | **Go** | ~5% | Gin, Echo, Fiber, Chi, Buffalo | GORM, Ent, sqlx, sqlc | ✅ Full |
468
+ | **Ruby** | ~3% | Ruby on Rails, Sinatra, Hanami, Grape | ActiveRecord, Sequel, ROM | ✅ Full |
469
+ | **Kotlin** | ~2% | Ktor, Spring Boot, Javalin, http4k | Exposed, Hibernate | ✅ Full |
470
+ | **Rust** | ~1% | Actix-web, Rocket, Axum, Warp | Diesel, SeaORM, sqlx | ✅ Full |
471
+ | **Elixir** | <1% | Phoenix | Ecto | ✅ Full |
472
+ | **Scala** | <1% | Play Framework, Akka HTTP | Slick, Quill | ✅ Full |
473
+ | **Swift** | <1% | Vapor | Fluent | ✅ Full |
474
+
475
+ ## **See [GETTING-STARTED.md](GETTING-STARTED.md) for automatic detection details and examples.**
476
+
477
+ ## 🎓 Why Use AI Flow?
478
+
479
+ **Without AI Flow:**
480
+
481
+ - ⏱️ 10-20 hours creating docs manually
482
+ - 🤔 AI assistants lack context, make assumptions
483
+ - 🐛 More bugs due to unclear standards
484
+
485
+ **With AI Flow:**
486
+
487
+ - ⏱️ 90-120 min (new) or 35-70 min (existing)
488
+ - 🤖 AI assistants work with full context and continuous workflow
489
+ - ✅ Consistent quality, fewer bugs
490
+ - 💾 Save 10-20 hours per project
491
+
492
+ ---
493
+
494
+ ## 📚 Documentation Philosophy
495
+
496
+ AI Flow follows: **Documentation as Executable Code**
497
+
498
+ - Documents guide AI assistants (like config files guide compilers)
499
+ - `AGENT.md` is the universal entry point
500
+ - All documents are interconnected
501
+ - Documents evolve with your project
502
+ - Single source of truth for all AI tools
503
+
504
+ ---
505
+
506
+ ## 🎯 Who Should Use This?
507
+
508
+ **Perfect for:**
509
+
510
+ - ✅ Backend/frontend/mobile/desktop developers starting new projects
511
+ - ✅ Teams with existing codebases needing AI-ready documentation
512
+ - ✅ Projects requiring comprehensive documentation
513
+ - Teams adopting AI-assisted development
514
+ - ✅ Multi-language teams (12 languages supported)
515
+
516
+ **Not ideal for:**
517
+
518
+ - ❌ Projects with zero documentation needs
519
+ - ❌ Quick prototypes that won't be maintained
520
+
521
+ ---
522
+
523
+ ## 🚀 Roadmap
524
+
525
+ - [x] Backend, frontend, mobile, desktop, fullstack support ✅
526
+ - [ ] Template customization
527
+ - [ ] VS Code extension
528
+ - [ ] Interactive web UI
529
+
530
+ ---
531
+
532
+ ## 🛠️ Troubleshooting
533
+
534
+ **Common issues:**
535
+
536
+ - Node.js version must be ≥20.0.0
537
+ - Check folder permissions if CLI can't write files
538
+ - Verify slash command files exist for your AI tool:
539
+ - **GitHub Copilot:** `.github/prompts/*.prompt.md`
540
+ - **Claude:** `.claude/commands/*.md`
541
+ - **Cursor:** `.cursor/commands/*.md`
542
+ - **Gemini:** `.gemini/commands/*.md`
543
+ - **Antigravity:** `.agent/workflows/*.md`
544
+ - If missing, re-run: `ai-flow init . --ai <your-tool>`
545
+
546
+ **📚 See [GETTING-STARTED.md](GETTING-STARTED.md#troubleshooting) for detailed troubleshooting guide**
547
+
548
+ ## 🤝 Contributing
549
+
550
+ ## We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
551
+
552
+ ## 📝 License
553
+
554
+ ## MIT License - See [LICENSE](LICENSE) for details.
555
+
556
+ ## 💬 Support
557
+
558
+ - **Issues:** [GitHub Issues](https://github.com/victorvelazquez/ai-flow/issues)
559
+ - **Email:** support@ai-flow.dev (if applicable)
560
+
561
+ ---
562
+
563
+ ## 🙏 Acknowledgments
564
+
565
+ - Inspired by [GitHub Spec-Kit](https://github.com/github/spec-kit)
566
+ - Built for the AI-assisted development era
567
+ - Community feedback and contributions
568
+
569
+ ---
570
+
571
+ **Transform your idea into a production-ready project with AI Flow** 🚀
572
+
573
+ **Made with ❤️ for the developer community**