ai-flow-dev 1.0.3 → 1.1.2
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.
- package/README.md +60 -35
- package/dist/cli.js +204 -236
- package/dist/cli.js.map +1 -1
- package/dist/fs-utils.js +3 -39
- package/dist/fs-utils.js.map +1 -1
- package/package.json +11 -12
- package/prompts/backend/{flow-docs-gen-phase-7.md → flow-bootstrap-phase-7.md} +41 -108
- package/prompts/backend/flow-bootstrap-phase-8.md +911 -0
- package/prompts/backend/{flow-project-roadmap.md → flow-bootstrap-phase-9.md} +255 -344
- package/prompts/backend/{flow-docs-gen.md → flow-bootstrap.md} +102 -37
- package/prompts/frontend/{flow-docs-gen-phase-0.md → flow-bootstrap-phase-0.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-1.md → flow-bootstrap-phase-1.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-3.md → flow-bootstrap-phase-3.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-4.md → flow-bootstrap-phase-4.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-5.md → flow-bootstrap-phase-5.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-6.md → flow-bootstrap-phase-6.md} +2 -1
- package/prompts/frontend/{flow-docs-gen-phase-7.md → flow-bootstrap-phase-7.md} +225 -200
- package/prompts/frontend/flow-bootstrap-phase-8.md +670 -0
- package/prompts/frontend/{flow-docs-gen.md → flow-bootstrap.md} +47 -20
- package/prompts/frontend/flow-docs-sync.md +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-0.md → flow-bootstrap-phase-0.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-1.md → flow-bootstrap-phase-1.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-2.md → flow-bootstrap-phase-2.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-3.md → flow-bootstrap-phase-3.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-4.md → flow-bootstrap-phase-4.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-5.md → flow-bootstrap-phase-5.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-6.md → flow-bootstrap-phase-6.md} +2 -1
- package/prompts/mobile/{flow-docs-gen-phase-7.md → flow-bootstrap-phase-7.md} +174 -132
- package/prompts/mobile/flow-bootstrap-phase-8.md +676 -0
- package/prompts/mobile/{flow-docs-gen.md → flow-bootstrap.md} +47 -20
- package/prompts/mobile/flow-docs-sync.md +2 -1
- package/templates/shared/AGENT.template.md +1 -1
- package/prompts/backend/flow-project-init.md +0 -332
- /package/prompts/backend/{flow-docs-gen-phase-0.md → flow-bootstrap-phase-0.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-1.md → flow-bootstrap-phase-1.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-2.md → flow-bootstrap-phase-2.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-3.md → flow-bootstrap-phase-3.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-4.md → flow-bootstrap-phase-4.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-5.md → flow-bootstrap-phase-5.md} +0 -0
- /package/prompts/backend/{flow-docs-gen-phase-6.md → flow-bootstrap-phase-6.md} +0 -0
- /package/prompts/frontend/{flow-docs-gen-phase-2.md → flow-bootstrap-phase-2.md} +0 -0
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ AI Flow is an interactive CLI that creates comprehensive professional documentat
|
|
|
10
10
|
|
|
11
11
|
**Key Features:**
|
|
12
12
|
|
|
13
|
-
- 🚀 Complete professional documentation (
|
|
13
|
+
- 🚀 Complete professional documentation (14-17 docs per project type)
|
|
14
14
|
- ⚡ **Two modes:** Interactive (90-120 min, full control) or Smart Auto-Suggest (15-25 min, 6 questions)
|
|
15
15
|
- 🌍 Universal support - 12 languages, 60+ frameworks, 35+ ORMs (98% coverage)
|
|
16
16
|
- 🤖 Multi-AI support with slash commands
|
|
@@ -22,7 +22,7 @@ AI Flow is an interactive CLI that creates comprehensive professional documentat
|
|
|
22
22
|
```bash
|
|
23
23
|
npm install -g ai-flow-dev
|
|
24
24
|
ai-flow init .
|
|
25
|
-
# Then open your AI tool and run: /flow-
|
|
25
|
+
# Then open your AI tool and run: /flow-bootstrap
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
📚 **[Complete Guide →](GETTING-STARTED.md)**
|
|
@@ -35,7 +35,7 @@ Transforma tu idea en un proyecto listo para producción y documentado para IA e
|
|
|
35
35
|
|
|
36
36
|
**Características:**
|
|
37
37
|
|
|
38
|
-
- 🚀 Documentación profesional completa (
|
|
38
|
+
- 🚀 Documentación profesional completa (14-17 docs por tipo)
|
|
39
39
|
- ⚡ **Dos modos:** Interactivo (90-120 min, control total) o Auto-Sugerido (15-25 min, 6 preguntas)
|
|
40
40
|
- 🌍 Soporte universal - 12 lenguajes, 60+ frameworks, 35+ ORMs
|
|
41
41
|
- 🤖 Compatible con Claude, Copilot, Cursor, Gemini
|
|
@@ -47,7 +47,7 @@ Transforma tu idea en un proyecto listo para producción y documentado para IA e
|
|
|
47
47
|
```bash
|
|
48
48
|
npm install -g ai-flow-dev
|
|
49
49
|
ai-flow init .
|
|
50
|
-
# Luego en tu herramienta IA: /flow-
|
|
50
|
+
# Luego en tu herramienta IA: /flow-bootstrap
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
📚 **[Guía Completa →](GETTING-STARTED.md)**
|
|
@@ -59,7 +59,7 @@ ai-flow init .
|
|
|
59
59
|
Transforme sua ideia em um projeto pronto para produção e documentado para IA em minutos.
|
|
60
60
|
**Características:**
|
|
61
61
|
|
|
62
|
-
- 🚀 Documentação profissional completa (
|
|
62
|
+
- 🚀 Documentação profissional completa (14-17 docs por tipo)
|
|
63
63
|
- ⚡ **Dois modos:** Interativo (90-120 min, controle total) ou Auto-Sugestão (15-25 min, 6 perguntas)
|
|
64
64
|
- 🌍 Suporte universal - 12 linguagens, 60+ frameworks, 35+ ORMs
|
|
65
65
|
- 🤖 Compatível com Claude, Copilot, Cursor, Gemini
|
|
@@ -72,7 +72,7 @@ Transforme sua ideia em um projeto pronto para produção e documentado para IA
|
|
|
72
72
|
```bash
|
|
73
73
|
npm install -g ai-flow-dev
|
|
74
74
|
ai-flow init .
|
|
75
|
-
# Em seguida, na sua ferramenta de IA: /flow-
|
|
75
|
+
# Em seguida, na sua ferramenta de IA: /flow-bootstrap
|
|
76
76
|
```
|
|
77
77
|
|
|
78
78
|
📚 **[Guia Completo →](GETTING-STARTED.md)**
|
|
@@ -97,22 +97,20 @@ The result is interconnected documentation that guides AI assistants and human d
|
|
|
97
97
|
|
|
98
98
|
- 🌍 **Universal Support** - 12 languages, 60+ frameworks, 35+ ORMs (98% coverage)
|
|
99
99
|
- 🤖 **AI-Agnostic** - Claude, Copilot, Cursor, Gemini, any AI tool
|
|
100
|
-
- 📚 **Professional Documentation** -
|
|
100
|
+
- 📚 **Professional Documentation** - 14-17 docs per project type
|
|
101
101
|
- ⚡ **Two Questionnaire Modes:**
|
|
102
102
|
- **Interactive Mode:** Full control, 71 questions (90-120 min)
|
|
103
103
|
- **Smart Auto-Suggest:** Only 6 critical questions, AI suggests best practices (15-25 min)
|
|
104
104
|
- 🔍 **Smart 3-Layer Detection** - Analyzes existing projects in 15s-5min
|
|
105
105
|
- 💾 **Intelligent Caching** - 0 seconds on re-runs with no changes
|
|
106
|
-
- 💡 **Slash Commands** - Easy execution with `/flow-
|
|
107
|
-
- ⏱️ **Time Efficient** - Save 10-20 hours per projectth no changes
|
|
108
|
-
- 💡 **Slash Commands** - Easy execution with `/flow-docs-gen`, `/flow-dev-feature`, `/flow-dev-fix`
|
|
106
|
+
- 💡 **Slash Commands** - Easy execution with `/flow-bootstrap`, `/flow-dev-feature`, `/flow-dev-fix`
|
|
109
107
|
- ⏱️ **Time Efficient** - Save 10-20 hours per project
|
|
110
108
|
|
|
111
109
|
---
|
|
112
110
|
|
|
113
111
|
## 📋 Prerequisites
|
|
114
112
|
|
|
115
|
-
- **Node.js:**
|
|
113
|
+
- **Node.js:** 20.0.0 or higher ([Download](https://nodejs.org/))
|
|
116
114
|
- **npm:** Included with Node.js
|
|
117
115
|
|
|
118
116
|
---
|
|
@@ -129,7 +127,7 @@ Or using uv (Python tool manager):
|
|
|
129
127
|
uv tool install ai-flow-dev
|
|
130
128
|
```
|
|
131
129
|
|
|
132
|
-
**Current version:** 1.
|
|
130
|
+
**Current version:** 1.1.1
|
|
133
131
|
|
|
134
132
|
---
|
|
135
133
|
|
|
@@ -144,7 +142,7 @@ cd my-awesome-project
|
|
|
144
142
|
ai-flow init .
|
|
145
143
|
|
|
146
144
|
# 3. Open your AI tool and run:
|
|
147
|
-
/flow-
|
|
145
|
+
/flow-bootstrap
|
|
148
146
|
```
|
|
149
147
|
|
|
150
148
|
That's it! The AI will guide you through an interactive questionnaire to generate all documentation.
|
|
@@ -184,6 +182,26 @@ ai-flow init .
|
|
|
184
182
|
|
|
185
183
|
# Hybrid mode (some flags, some prompts)
|
|
186
184
|
ai-flow init . --ai claude
|
|
185
|
+
|
|
186
|
+
# Specify project type directly
|
|
187
|
+
ai-flow init . --type backend
|
|
188
|
+
|
|
189
|
+
# Combine type with AI tool
|
|
190
|
+
ai-flow init . --ai claude --type fullstack
|
|
191
|
+
|
|
192
|
+
# Enable verbose output (detailed logging)
|
|
193
|
+
ai-flow init . --verbose
|
|
194
|
+
ai-flow check --verbose
|
|
195
|
+
|
|
196
|
+
# Simulate initialization without writing files (dry-run)
|
|
197
|
+
ai-flow init . --dry-run --verbose
|
|
198
|
+
|
|
199
|
+
# Show detailed help with all commands and options
|
|
200
|
+
ai-flow --help
|
|
201
|
+
|
|
202
|
+
# Show help for specific command
|
|
203
|
+
ai-flow init --help
|
|
204
|
+
ai-flow check --help
|
|
187
205
|
```
|
|
188
206
|
|
|
189
207
|
---
|
|
@@ -219,24 +237,25 @@ Each tool gets:
|
|
|
219
237
|
|
|
220
238
|
After initialization, use these slash commands in your AI tool:
|
|
221
239
|
|
|
240
|
+
**Backend Projects:** 17 commands
|
|
241
|
+
**Frontend/Mobile Projects:** 11 commands (bootstrap + docs-sync)
|
|
242
|
+
**Fullstack Projects:** Combined backend + frontend commands
|
|
243
|
+
|
|
222
244
|
**Documentation & Bootstrap:**
|
|
223
245
|
|
|
224
|
-
- `/flow-
|
|
225
|
-
- `/flow-
|
|
226
|
-
- `/flow-
|
|
227
|
-
- `/flow-
|
|
228
|
-
- `/flow-
|
|
229
|
-
- `/flow-
|
|
230
|
-
- `/flow-
|
|
231
|
-
- `/flow-
|
|
232
|
-
- `/flow-
|
|
246
|
+
- `/flow-bootstrap` - Full 9-phase project bootstrap (includes docs + setup + roadmap)
|
|
247
|
+
- `/flow-bootstrap-phase-0` - Context discovery (existing projects)
|
|
248
|
+
- `/flow-bootstrap-phase-1` - Business requirements
|
|
249
|
+
- `/flow-bootstrap-phase-2` - Data architecture
|
|
250
|
+
- `/flow-bootstrap-phase-3` - Technical architecture
|
|
251
|
+
- `/flow-bootstrap-phase-4` - Security & compliance
|
|
252
|
+
- `/flow-bootstrap-phase-5` - Code standards
|
|
253
|
+
- `/flow-bootstrap-phase-6` - Testing strategy
|
|
254
|
+
- `/flow-bootstrap-phase-7` - Deployment & operations
|
|
255
|
+
- `/flow-bootstrap-phase-8` - Project setup & final documentation
|
|
256
|
+
- `/flow-bootstrap-phase-9` - Implementation roadmap with Story Points (Backend only, optional)
|
|
233
257
|
- `/flow-docs-sync` - Update documentation when code changes
|
|
234
258
|
|
|
235
|
-
**Project Setup (Backend only):**
|
|
236
|
-
|
|
237
|
-
- `/flow-project-init` - Initialize project with framework (5-10 min, auto-executed by /flow-docs-gen)
|
|
238
|
-
- `/flow-project-roadmap` - Create implementation roadmap with Story Points (15-30 min)
|
|
239
|
-
|
|
240
259
|
**Workflows (Backend only):**
|
|
241
260
|
|
|
242
261
|
- `/flow-dev-feature` - Create/modify features (15-20 min)
|
|
@@ -245,7 +264,7 @@ After initialization, use these slash commands in your AI tool:
|
|
|
245
264
|
- `/flow-dev-review` - Multi-aspect code review (5 min)
|
|
246
265
|
- `/flow-dev-refactor-quick` - Quick refactorings (3-5 min)
|
|
247
266
|
|
|
248
|
-
> **Note:** Frontend and Mobile projects include
|
|
267
|
+
> **Note:** Frontend and Mobile projects include bootstrap commands (`/flow-bootstrap`, phases, `/flow-docs-sync`) but not workflow commands.
|
|
249
268
|
|
|
250
269
|
**📚 See [GETTING-STARTED.md](GETTING-STARTED.md) for complete command reference**
|
|
251
270
|
|
|
@@ -254,10 +273,11 @@ After initialization, use these slash commands in your AI tool:
|
|
|
254
273
|
## 💡 How It Works
|
|
255
274
|
|
|
256
275
|
1. **Smart Detection** - Analyzes existing projects in 3 layers (15s to 5min)
|
|
257
|
-
2. **Interactive Questionnaire** - Guides you through 8 phases (choose mode)
|
|
258
|
-
3. **Template Generation** - Creates
|
|
259
|
-
4. **
|
|
260
|
-
5. **
|
|
276
|
+
2. **Interactive Questionnaire** - Guides you through 8-9 phases (choose mode)
|
|
277
|
+
3. **Template Generation** - Creates 14-17 professional documents
|
|
278
|
+
4. **Implementation Roadmap** - Optional Phase 9 generates Story Point estimates
|
|
279
|
+
5. **AI Integration** - Configures your AI tool with project context
|
|
280
|
+
6. **Slash Command Setup** - Installs prompts to tool-specific paths (.github/prompts/, .claude/commands/, etc.)
|
|
261
281
|
|
|
262
282
|
**For existing projects:**
|
|
263
283
|
|
|
@@ -276,7 +296,7 @@ After initialization, use these slash commands in your AI tool:
|
|
|
276
296
|
|
|
277
297
|
## 🎯 Generated Documentation
|
|
278
298
|
|
|
279
|
-
**Backend** (17 docs): AGENT.md, ai-instructions.md, project-brief.md, README.md, 9 technical docs, 2 specs, .env.example
|
|
299
|
+
**Backend** (17 docs): AGENT.md, ai-instructions.md, copilot-instructions.md (for GitHub Copilot), project-brief.md, README.md, 9 technical docs, 2 specs, .env.example, .clauderules, .cursorrules
|
|
280
300
|
|
|
281
301
|
**Frontend** (15 docs): AGENT.md, ai-instructions.md, project-brief.md, README.md, 9 technical docs, 3 specs
|
|
282
302
|
|
|
@@ -370,9 +390,14 @@ AI Flow follows: **Documentation as Executable Code**
|
|
|
370
390
|
|
|
371
391
|
**Common issues:**
|
|
372
392
|
|
|
373
|
-
- Node.js version must be ≥
|
|
393
|
+
- Node.js version must be ≥20.0.0
|
|
374
394
|
- Check folder permissions if CLI can't write files
|
|
375
|
-
- Verify slash command files exist for your AI tool
|
|
395
|
+
- Verify slash command files exist for your AI tool:
|
|
396
|
+
- **GitHub Copilot:** `.github/prompts/*.prompt.md`
|
|
397
|
+
- **Claude:** `.claude/commands/*.md`
|
|
398
|
+
- **Cursor:** `.cursor/commands/*.md`
|
|
399
|
+
- **Gemini:** `.gemini/commands/*.md`
|
|
400
|
+
- If missing, re-run: `ai-flow init . --ai <your-tool>`
|
|
376
401
|
|
|
377
402
|
**📚 See [GETTING-STARTED.md](GETTING-STARTED.md#troubleshooting) for detailed troubleshooting guide**
|
|
378
403
|
|