ai-flow-dev 2.7.0 → 2.8.1

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 +717 -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 +717 -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 +919 -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 +717 -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 +919 -0
  70. package/prompts/frontend/flow-release.md +519 -0
  71. package/prompts/frontend/flow-work-api.md +1547 -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 +1595 -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 +717 -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 +919 -0
  95. package/prompts/mobile/flow-release.md +751 -0
  96. package/prompts/mobile/flow-work-api.md +1500 -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 +1605 -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 +61 -47
@@ -1,443 +1,443 @@
1
- # AGENT.md
2
-
3
- > Universal AI Assistant Configuration
4
- >
5
- > This file provides context for ALL AI development tools (Claude, Copilot, Cursor, Gemini, etc.)
6
-
7
- ---
8
-
9
- ## 📋 About This Project
10
-
11
- **Project Name:** {{PROJECT_NAME}}
12
-
13
- **Description:** {{PROJECT_DESCRIPTION}}
14
-
15
- **Problem We're Solving:** {{PROBLEM_STATEMENT}}
16
-
17
- **Target Users:** {{TARGET_USERS}}
18
-
19
- ### Technical Context
20
-
21
- **Project Type:** Backend API/Service
22
- **Architecture:** {{ARCHITECTURE_PATTERN}}
23
- **Primary Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
24
- **Framework:** {{FRAMEWORK}}
25
- **Database:** {{DATABASE}} with {{ORM}}
26
-
27
- **Key Characteristics:**
28
-
29
- - Authentication: {{AUTH_METHOD}}
30
- - API Style: {{API_STYLE}}
31
- - Deployment: {{DEPLOYMENT_PLATFORM}}
32
- - Current Phase: {{PROJECT_PHASE}}
33
-
34
- > This project uses AI-assisted development with comprehensive documentation.
35
- > All files below provide context to AI assistants for consistent, high-quality code generation.
36
-
37
- ---
38
-
39
- ## 🏗️ Documentation Architecture
40
-
41
- This project follows **AI-assisted development** with comprehensive documentation.
42
- All documentation is structured to guide AI assistants in understanding the project deeply.
43
-
44
- ### 📚 Core Documentation (Read in Order)
45
-
46
- 1. **`ai-instructions.md`** ⭐ **START HERE**
47
- - Tech stack and versions
48
- - NEVER/ALWAYS rules
49
- - Development workflow
50
- - Priorities
51
-
52
- 2. **`project-brief.md`**
53
- - Business context
54
- - Objectives and scope
55
- - Constraints and success metrics
56
-
57
- 3. **`README.md`**
58
- - Quick start
59
- - Installation and commands
60
- - Project directory tour
61
-
62
- 4. **`docs/architecture.md`**
63
- - System architecture pattern
64
- - Component structure
65
- - Request/response flow
66
-
67
- 5. **`docs/data-model.md`**
68
- - Database schema
69
- - Entity relationships
70
- - Data patterns
71
-
72
- 6. **`docs/code-standards.md`**
73
- - Naming conventions
74
- - Code quality rules
75
- - Error handling patterns
76
-
77
- 7. **`docs/testing.md`**
78
- - Testing strategy
79
- - Coverage requirements
80
- - Test patterns
81
-
82
- 8. **`docs/operations.md`**
83
- - Deployment procedures
84
- - Monitoring and alerts
85
- - Scaling strategy
86
-
87
- 9. **`docs/business-flows.md`**
88
- - End-to-end business processes
89
- - Key actors and systems
90
- - Flow diagrams
91
-
92
- 10. **`docs/api.md`**
93
- - Endpoint conventions
94
- - Authentication and pagination rules
95
- - Request/response examples
96
-
97
- 11. **`docs/contributing.md`**
98
- - Development setup
99
- - Contribution guidelines
100
- - Code review process
101
-
102
- 12. **`specs/security.md`**
103
- - Authentication/Authorization
104
- - Security policies
105
- - Compliance requirements
106
-
107
- 13. **`specs/configuration.md`**
108
- - Environment variables
109
- - External services
110
- - Configuration by environment
111
-
112
- 14. **`.env.example`**
113
- - Required environment variables
114
- - Default/local values
115
- - Secrets handling guidance
116
-
117
- ---
118
-
119
- ## ⚡ Quick Reference
120
-
121
- ### Tech Stack
122
-
123
- **Backend:**
124
-
125
- - Framework: {{FRAMEWORK}}
126
- - Language: {{LANGUAGE}} {{LANGUAGE_VERSION}}
127
- - Database: {{DATABASE}}
128
- - ORM: {{ORM}}
129
- - Authentication: {{AUTH_METHOD}}
130
- - Caching: {{CACHE_STRATEGY}}
131
-
132
- **Infrastructure:**
133
-
134
- - Deployment: {{DEPLOYMENT_PLATFORM}}
135
- - CI/CD: {{CICD_PLATFORM}}
136
- - Monitoring: {{MONITORING_TOOLS}}
137
-
138
- ### Critical Rules
139
-
140
- **❌ NEVER:**
141
- {{NEVER_RULES}}
142
-
143
- **✅ ALWAYS:**
144
- {{ALWAYS_RULES}}
145
-
146
- ---
147
-
148
- ## 🤖 AI Assistant Workflow
149
-
150
- When working on this project:
151
-
152
- 1. **🚀 Proactive Execution (MANDATORY):**
153
- - When any command starting with `/flow-` is detected (e.g., `/flow-build`, `/flow-work`, `/flow-check`), **IMMEDIATELY enter AGENT/EXECUTION MODE**.
154
- - **Do NOT ask for permission** to read files, write documents, or execute shell commands that are part of the interactive flow.
155
- - These flows already include their own internal planning and confirmation steps. Proactivity is key to efficiency.
156
-
157
- 2. **Before starting ANY task:**
158
- - Read `ai-instructions.md` for project-wide rules
159
- - Check relevant documentation for the area you're working on
160
- - Understand the business context from `project-brief.md`
161
-
162
- 3. **When implementing features:**
163
- - Follow architecture patterns from `docs/architecture.md`
164
- - Respect data models from `docs/data-model.md`
165
- - Apply code standards from `docs/code-standards.md`
166
- - Add tests according to `docs/testing.md`
167
-
168
- 4. **When handling security:**
169
- - Consult `specs/security.md` for auth/authz
170
- - Never hardcode secrets (use `specs/configuration.md`)
171
- - Follow security headers and encryption requirements
172
-
173
- 5. **When deploying:**
174
- - Follow procedures in `docs/operations.md`
175
- - Update configuration per environment
176
- - Check health endpoints
177
-
178
- ---
179
-
180
- ## 🛠️ Tool-Specific Configurations
181
-
182
- Different AI tools have specific configuration files that extend this AGENT.md:
183
-
184
- ### Claude Code
185
-
186
- - **File:** `.clauderules`
187
- - **Purpose:** Claude-specific instructions and preferences
188
- - **References:** This AGENT.md + project docs
189
-
190
- ### Cursor
191
-
192
- - **File:** `.cursorrules`
193
- - **Purpose:** Cursor-specific context and rules
194
- - **References:** This AGENT.md + project docs
195
-
196
- ### GitHub Copilot
197
-
198
- - **File:** `.github/copilot-instructions.md`
199
- - **Purpose:** Copilot workspace instructions
200
- - **References:** This AGENT.md + project docs
201
-
202
- ## **All tool-specific configs reference this AGENT.md as the source of truth.**
203
-
204
- ## 📊 Project Status
205
-
206
- **Current Phase:** {{PROJECT_PHASE}}
207
-
208
- **Architecture:** {{ARCHITECTURE_PATTERN}}
209
-
210
- ## **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
211
-
212
- ## 🚀 Getting Started
213
-
214
- ### For AI Assistants
215
-
216
- 1. Read this AGENT.md completely
217
- 2. Read `ai-instructions.md` for critical rules
218
- 3. Familiarize with `docs/architecture.md`
219
- 4. Review `docs/code-standards.md` for coding patterns
220
- 5. Check `specs/security.md` before handling auth/sensitive data
221
-
222
- ### For Developers
223
-
224
- ## See `README.md` for installation and setup instructions.
225
-
226
- ## 📝 Document Update Policy
227
-
228
- - Documents are **living artifacts** - update as project evolves
229
- - Breaking changes to architecture → Update `docs/architecture.md`
230
- **Architecture:** {{ARCHITECTURE_PATTERN}}
231
- **Primary Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
232
- **Framework:** {{FRAMEWORK}}
233
- **Database:** {{DATABASE}} with {{ORM}}
234
-
235
- **Key Characteristics:**
236
-
237
- - Authentication: {{AUTH_METHOD}}
238
- - API Style: {{API_STYLE}}
239
- - Deployment: {{DEPLOYMENT_PLATFORM}}
240
- - Current Phase: {{PROJECT_PHASE}}
241
-
242
- > This project uses AI-assisted development with comprehensive documentation.
243
- > All files below provide context to AI assistants for consistent, high-quality code generation.
244
-
245
- ---
246
-
247
- ## 🏗️ Documentation Architecture
248
-
249
- This project follows **AI-assisted development** with comprehensive documentation.
250
- All documentation is structured to guide AI assistants in understanding the project deeply.
251
-
252
- ### 📚 Core Documentation (Read in Order)
253
-
254
- 1. **`ai-instructions.md`** ⭐ **START HERE**
255
- - Tech stack and versions
256
- - NEVER/ALWAYS rules
257
- - Development workflow
258
- - Priorities
259
-
260
- 2. **`project-brief.md`**
261
- - Business context
262
- - Objectives and scope
263
- - Constraints and success metrics
264
-
265
- 3. **`README.md`**
266
- - Quick start
267
- - Installation and commands
268
- - Project directory tour
269
-
270
- 4. **`docs/architecture.md`**
271
- - System architecture pattern
272
- - Component structure
273
- - Request/response flow
274
-
275
- 5. **`docs/data-model.md`**
276
- - Database schema
277
- - Entity relationships
278
- - Data patterns
279
-
280
- 6. **`docs/code-standards.md`**
281
- - Naming conventions
282
- - Code quality rules
283
- - Error handling patterns
284
-
285
- 7. **`docs/testing.md`**
286
- - Testing strategy
287
- - Coverage requirements
288
- - Test patterns
289
-
290
- 8. **`docs/operations.md`**
291
- - Deployment procedures
292
- - Monitoring and alerts
293
- - Scaling strategy
294
-
295
- 9. **`docs/business-flows.md`**
296
- - End-to-end business processes
297
- - Key actors and systems
298
- - Flow diagrams
299
-
300
- 10. **`docs/api.md`**
301
- - Endpoint conventions
302
- - Authentication and pagination rules
303
- - Request/response examples
304
-
305
- 11. **`docs/contributing.md`**
306
- - Development setup
307
- - Contribution guidelines
308
- - Code review process
309
-
310
- 12. **`specs/security.md`**
311
- - Authentication/Authorization
312
- - Security policies
313
- - Compliance requirements
314
-
315
- 13. **`specs/configuration.md`**
316
- - Environment variables
317
- - External services
318
- - Configuration by environment
319
-
320
- 14. **`.env.example`**
321
- - Required environment variables
322
- - Default/local values
323
- - Secrets handling guidance
324
-
325
- ---
326
-
327
- ## ⚡ Quick Reference
328
-
329
- ### Tech Stack
330
-
331
- **Backend:**
332
-
333
- - Framework: {{FRAMEWORK}}
334
- - Language: {{LANGUAGE}} {{LANGUAGE_VERSION}}
335
- - Database: {{DATABASE}}
336
- - ORM: {{ORM}}
337
- - Authentication: {{AUTH_METHOD}}
338
- - Caching: {{CACHE_STRATEGY}}
339
-
340
- **Infrastructure:**
341
-
342
- - Deployment: {{DEPLOYMENT_PLATFORM}}
343
- - CI/CD: {{CICD_PLATFORM}}
344
- - Monitoring: {{MONITORING_TOOLS}}
345
-
346
- ### Critical Rules
347
-
348
- **❌ NEVER:**
349
- {{NEVER_RULES}}
350
-
351
- **✅ ALWAYS:**
352
- {{ALWAYS_RULES}}
353
-
354
- ---
355
-
356
- ## 🤖 AI Assistant Workflow
357
-
358
- When working on this project:
359
-
360
- 1. **🚀 Proactive Execution (MANDATORY):**
361
- - When any command starting with `/flow-` is detected (e.g., `/flow-build`, `/flow-work`, `/flow-check`), **IMMEDIATELY enter AGENT/EXECUTION MODE**.
362
- - **Do NOT ask for permission** to read files, write documents, or execute shell commands that are part of the interactive flow.
363
- - These flows already include their own internal planning and confirmation steps. Proactivity is key to efficiency.
364
-
365
- 2. **Before starting ANY task:**
366
- - Read `ai-instructions.md` for project-wide rules
367
- - Check relevant documentation for the area you're working on
368
- - Understand the business context from `project-brief.md`
369
-
370
- 3. **When implementing features:**
371
- - Follow architecture patterns from `docs/architecture.md`
372
- - Respect data models from `docs/data-model.md`
373
- - Apply code standards from `docs/code-standards.md`
374
- - Add tests according to `docs/testing.md`
375
-
376
- 4. **When handling security:**
377
- - Consult `specs/security.md` for auth/authz
378
- - Never hardcode secrets (use `specs/configuration.md`)
379
- - Follow security headers and encryption requirements
380
-
381
- 5. **When deploying:**
382
- - Follow procedures in `docs/operations.md`
383
- - Update configuration per environment
384
- - Check health endpoints
385
-
386
- ---
387
-
388
- ## 🛠️ Tool-Specific Configurations
389
-
390
- Different AI tools have specific configuration files that extend this AGENT.md:
391
-
392
- ### Claude Code
393
-
394
- - **File:** `.clauderules`
395
- - **Purpose:** Claude-specific instructions and preferences
396
- - **References:** This AGENT.md + project docs
397
-
398
- ### Cursor
399
-
400
- - **File:** `.cursorrules`
401
- - **Purpose:** Cursor-specific context and rules
402
- - **References:** This AGENT.md + project docs
403
-
404
- ### GitHub Copilot
405
-
406
- - **File:** `.github/copilot-instructions.md`
407
- - **Purpose:** Copilot workspace instructions
408
- - **References:** This AGENT.md + project docs
409
-
410
- ## **All tool-specific configs reference this AGENT.md as the source of truth.**
411
-
412
- ## 📊 Project Status
413
-
414
- **Current Phase:** {{PROJECT_PHASE}}
415
-
416
- **Architecture:** {{ARCHITECTURE_PATTERN}}
417
-
418
- ## **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
419
-
420
- ## 🚀 Getting Started
421
-
422
- ### For AI Assistants
423
-
424
- 1. Read this AGENT.md completely
425
- 2. Read `ai-instructions.md` for critical rules
426
- 3. Familiarize with `docs/architecture.md`
427
- 4. Review `docs/code-standards.md` for coding patterns
428
- 5. Check `specs/security.md` before handling auth/sensitive data
429
-
430
- ### For Developers
431
-
432
- ## See `README.md` for installation and setup instructions.
433
-
434
- ## 📝 Document Update Policy
435
-
436
- - Documents are **living artifacts** - update as project evolves
437
- - Breaking changes to architecture → Update `docs/architecture.md`
438
- - New security requirements → Update `specs/security.md`
439
- - Stack changes → Update `ai-instructions.md` AND this AGENT.md
440
-
441
- **Last Updated:** {{GENERATION_DATE}}
442
-
443
- **Generated by:** AI Flow v2.7.0
1
+ # AGENT.md
2
+
3
+ > Universal AI Assistant Configuration
4
+ >
5
+ > This file provides context for ALL AI development tools (Claude, Copilot, Cursor, Gemini, etc.)
6
+
7
+ ---
8
+
9
+ ## 📋 About This Project
10
+
11
+ **Project Name:** {{PROJECT_NAME}}
12
+
13
+ **Description:** {{PROJECT_DESCRIPTION}}
14
+
15
+ **Problem We're Solving:** {{PROBLEM_STATEMENT}}
16
+
17
+ **Target Users:** {{TARGET_USERS}}
18
+
19
+ ### Technical Context
20
+
21
+ **Project Type:** Backend API/Service
22
+ **Architecture:** {{ARCHITECTURE_PATTERN}}
23
+ **Primary Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
24
+ **Framework:** {{FRAMEWORK}}
25
+ **Database:** {{DATABASE}} with {{ORM}}
26
+
27
+ **Key Characteristics:**
28
+
29
+ - Authentication: {{AUTH_METHOD}}
30
+ - API Style: {{API_STYLE}}
31
+ - Deployment: {{DEPLOYMENT_PLATFORM}}
32
+ - Current Phase: {{PROJECT_PHASE}}
33
+
34
+ > This project uses AI-assisted development with comprehensive documentation.
35
+ > All files below provide context to AI assistants for consistent, high-quality code generation.
36
+
37
+ ---
38
+
39
+ ## 🏗️ Documentation Architecture
40
+
41
+ This project follows **AI-assisted development** with comprehensive documentation.
42
+ All documentation is structured to guide AI assistants in understanding the project deeply.
43
+
44
+ ### 📚 Core Documentation (Read in Order)
45
+
46
+ 1. **`ai-instructions.md`** ⭐ **START HERE**
47
+ - Tech stack and versions
48
+ - NEVER/ALWAYS rules
49
+ - Development workflow
50
+ - Priorities
51
+
52
+ 2. **`project-brief.md`**
53
+ - Business context
54
+ - Objectives and scope
55
+ - Constraints and success metrics
56
+
57
+ 3. **`README.md`**
58
+ - Quick start
59
+ - Installation and commands
60
+ - Project directory tour
61
+
62
+ 4. **`docs/architecture.md`**
63
+ - System architecture pattern
64
+ - Component structure
65
+ - Request/response flow
66
+
67
+ 5. **`docs/data-model.md`**
68
+ - Database schema
69
+ - Entity relationships
70
+ - Data patterns
71
+
72
+ 6. **`docs/code-standards.md`**
73
+ - Naming conventions
74
+ - Code quality rules
75
+ - Error handling patterns
76
+
77
+ 7. **`docs/testing.md`**
78
+ - Testing strategy
79
+ - Coverage requirements
80
+ - Test patterns
81
+
82
+ 8. **`docs/operations.md`**
83
+ - Deployment procedures
84
+ - Monitoring and alerts
85
+ - Scaling strategy
86
+
87
+ 9. **`docs/business-flows.md`**
88
+ - End-to-end business processes
89
+ - Key actors and systems
90
+ - Flow diagrams
91
+
92
+ 10. **`docs/api.md`**
93
+ - Endpoint conventions
94
+ - Authentication and pagination rules
95
+ - Request/response examples
96
+
97
+ 11. **`docs/contributing.md`**
98
+ - Development setup
99
+ - Contribution guidelines
100
+ - Code review process
101
+
102
+ 12. **`specs/security.md`**
103
+ - Authentication/Authorization
104
+ - Security policies
105
+ - Compliance requirements
106
+
107
+ 13. **`specs/configuration.md`**
108
+ - Environment variables
109
+ - External services
110
+ - Configuration by environment
111
+
112
+ 14. **`.env.example`**
113
+ - Required environment variables
114
+ - Default/local values
115
+ - Secrets handling guidance
116
+
117
+ ---
118
+
119
+ ## ⚡ Quick Reference
120
+
121
+ ### Tech Stack
122
+
123
+ **Backend:**
124
+
125
+ - Framework: {{FRAMEWORK}}
126
+ - Language: {{LANGUAGE}} {{LANGUAGE_VERSION}}
127
+ - Database: {{DATABASE}}
128
+ - ORM: {{ORM}}
129
+ - Authentication: {{AUTH_METHOD}}
130
+ - Caching: {{CACHE_STRATEGY}}
131
+
132
+ **Infrastructure:**
133
+
134
+ - Deployment: {{DEPLOYMENT_PLATFORM}}
135
+ - CI/CD: {{CICD_PLATFORM}}
136
+ - Monitoring: {{MONITORING_TOOLS}}
137
+
138
+ ### Critical Rules
139
+
140
+ **❌ NEVER:**
141
+ {{NEVER_RULES}}
142
+
143
+ **✅ ALWAYS:**
144
+ {{ALWAYS_RULES}}
145
+
146
+ ---
147
+
148
+ ## 🤖 AI Assistant Workflow
149
+
150
+ When working on this project:
151
+
152
+ 1. **🚀 Proactive Execution (MANDATORY):**
153
+ - When any command starting with `/flow-` is detected (e.g., `/flow-build`, `/flow-work`, `/flow-check`), **IMMEDIATELY enter AGENT/EXECUTION MODE**.
154
+ - **Do NOT ask for permission** to read files, write documents, or execute shell commands that are part of the interactive flow.
155
+ - These flows already include their own internal planning and confirmation steps. Proactivity is key to efficiency.
156
+
157
+ 2. **Before starting ANY task:**
158
+ - Read `ai-instructions.md` for project-wide rules
159
+ - Check relevant documentation for the area you're working on
160
+ - Understand the business context from `project-brief.md`
161
+
162
+ 3. **When implementing features:**
163
+ - Follow architecture patterns from `docs/architecture.md`
164
+ - Respect data models from `docs/data-model.md`
165
+ - Apply code standards from `docs/code-standards.md`
166
+ - Add tests according to `docs/testing.md`
167
+
168
+ 4. **When handling security:**
169
+ - Consult `specs/security.md` for auth/authz
170
+ - Never hardcode secrets (use `specs/configuration.md`)
171
+ - Follow security headers and encryption requirements
172
+
173
+ 5. **When deploying:**
174
+ - Follow procedures in `docs/operations.md`
175
+ - Update configuration per environment
176
+ - Check health endpoints
177
+
178
+ ---
179
+
180
+ ## 🛠️ Tool-Specific Configurations
181
+
182
+ Different AI tools have specific configuration files that extend this AGENT.md:
183
+
184
+ ### Claude Code
185
+
186
+ - **File:** `.clauderules`
187
+ - **Purpose:** Claude-specific instructions and preferences
188
+ - **References:** This AGENT.md + project docs
189
+
190
+ ### Cursor
191
+
192
+ - **File:** `.cursorrules`
193
+ - **Purpose:** Cursor-specific context and rules
194
+ - **References:** This AGENT.md + project docs
195
+
196
+ ### GitHub Copilot
197
+
198
+ - **File:** `.github/copilot-instructions.md`
199
+ - **Purpose:** Copilot workspace instructions
200
+ - **References:** This AGENT.md + project docs
201
+
202
+ ## **All tool-specific configs reference this AGENT.md as the source of truth.**
203
+
204
+ ## 📊 Project Status
205
+
206
+ **Current Phase:** {{PROJECT_PHASE}}
207
+
208
+ **Architecture:** {{ARCHITECTURE_PATTERN}}
209
+
210
+ ## **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
211
+
212
+ ## 🚀 Getting Started
213
+
214
+ ### For AI Assistants
215
+
216
+ 1. Read this AGENT.md completely
217
+ 2. Read `ai-instructions.md` for critical rules
218
+ 3. Familiarize with `docs/architecture.md`
219
+ 4. Review `docs/code-standards.md` for coding patterns
220
+ 5. Check `specs/security.md` before handling auth/sensitive data
221
+
222
+ ### For Developers
223
+
224
+ ## See `README.md` for installation and setup instructions.
225
+
226
+ ## 📝 Document Update Policy
227
+
228
+ - Documents are **living artifacts** - update as project evolves
229
+ - Breaking changes to architecture → Update `docs/architecture.md`
230
+ **Architecture:** {{ARCHITECTURE_PATTERN}}
231
+ **Primary Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
232
+ **Framework:** {{FRAMEWORK}}
233
+ **Database:** {{DATABASE}} with {{ORM}}
234
+
235
+ **Key Characteristics:**
236
+
237
+ - Authentication: {{AUTH_METHOD}}
238
+ - API Style: {{API_STYLE}}
239
+ - Deployment: {{DEPLOYMENT_PLATFORM}}
240
+ - Current Phase: {{PROJECT_PHASE}}
241
+
242
+ > This project uses AI-assisted development with comprehensive documentation.
243
+ > All files below provide context to AI assistants for consistent, high-quality code generation.
244
+
245
+ ---
246
+
247
+ ## 🏗️ Documentation Architecture
248
+
249
+ This project follows **AI-assisted development** with comprehensive documentation.
250
+ All documentation is structured to guide AI assistants in understanding the project deeply.
251
+
252
+ ### 📚 Core Documentation (Read in Order)
253
+
254
+ 1. **`ai-instructions.md`** ⭐ **START HERE**
255
+ - Tech stack and versions
256
+ - NEVER/ALWAYS rules
257
+ - Development workflow
258
+ - Priorities
259
+
260
+ 2. **`project-brief.md`**
261
+ - Business context
262
+ - Objectives and scope
263
+ - Constraints and success metrics
264
+
265
+ 3. **`README.md`**
266
+ - Quick start
267
+ - Installation and commands
268
+ - Project directory tour
269
+
270
+ 4. **`docs/architecture.md`**
271
+ - System architecture pattern
272
+ - Component structure
273
+ - Request/response flow
274
+
275
+ 5. **`docs/data-model.md`**
276
+ - Database schema
277
+ - Entity relationships
278
+ - Data patterns
279
+
280
+ 6. **`docs/code-standards.md`**
281
+ - Naming conventions
282
+ - Code quality rules
283
+ - Error handling patterns
284
+
285
+ 7. **`docs/testing.md`**
286
+ - Testing strategy
287
+ - Coverage requirements
288
+ - Test patterns
289
+
290
+ 8. **`docs/operations.md`**
291
+ - Deployment procedures
292
+ - Monitoring and alerts
293
+ - Scaling strategy
294
+
295
+ 9. **`docs/business-flows.md`**
296
+ - End-to-end business processes
297
+ - Key actors and systems
298
+ - Flow diagrams
299
+
300
+ 10. **`docs/api.md`**
301
+ - Endpoint conventions
302
+ - Authentication and pagination rules
303
+ - Request/response examples
304
+
305
+ 11. **`docs/contributing.md`**
306
+ - Development setup
307
+ - Contribution guidelines
308
+ - Code review process
309
+
310
+ 12. **`specs/security.md`**
311
+ - Authentication/Authorization
312
+ - Security policies
313
+ - Compliance requirements
314
+
315
+ 13. **`specs/configuration.md`**
316
+ - Environment variables
317
+ - External services
318
+ - Configuration by environment
319
+
320
+ 14. **`.env.example`**
321
+ - Required environment variables
322
+ - Default/local values
323
+ - Secrets handling guidance
324
+
325
+ ---
326
+
327
+ ## ⚡ Quick Reference
328
+
329
+ ### Tech Stack
330
+
331
+ **Backend:**
332
+
333
+ - Framework: {{FRAMEWORK}}
334
+ - Language: {{LANGUAGE}} {{LANGUAGE_VERSION}}
335
+ - Database: {{DATABASE}}
336
+ - ORM: {{ORM}}
337
+ - Authentication: {{AUTH_METHOD}}
338
+ - Caching: {{CACHE_STRATEGY}}
339
+
340
+ **Infrastructure:**
341
+
342
+ - Deployment: {{DEPLOYMENT_PLATFORM}}
343
+ - CI/CD: {{CICD_PLATFORM}}
344
+ - Monitoring: {{MONITORING_TOOLS}}
345
+
346
+ ### Critical Rules
347
+
348
+ **❌ NEVER:**
349
+ {{NEVER_RULES}}
350
+
351
+ **✅ ALWAYS:**
352
+ {{ALWAYS_RULES}}
353
+
354
+ ---
355
+
356
+ ## 🤖 AI Assistant Workflow
357
+
358
+ When working on this project:
359
+
360
+ 1. **🚀 Proactive Execution (MANDATORY):**
361
+ - When any command starting with `/flow-` is detected (e.g., `/flow-build`, `/flow-work`, `/flow-check`), **IMMEDIATELY enter AGENT/EXECUTION MODE**.
362
+ - **Do NOT ask for permission** to read files, write documents, or execute shell commands that are part of the interactive flow.
363
+ - These flows already include their own internal planning and confirmation steps. Proactivity is key to efficiency.
364
+
365
+ 2. **Before starting ANY task:**
366
+ - Read `ai-instructions.md` for project-wide rules
367
+ - Check relevant documentation for the area you're working on
368
+ - Understand the business context from `project-brief.md`
369
+
370
+ 3. **When implementing features:**
371
+ - Follow architecture patterns from `docs/architecture.md`
372
+ - Respect data models from `docs/data-model.md`
373
+ - Apply code standards from `docs/code-standards.md`
374
+ - Add tests according to `docs/testing.md`
375
+
376
+ 4. **When handling security:**
377
+ - Consult `specs/security.md` for auth/authz
378
+ - Never hardcode secrets (use `specs/configuration.md`)
379
+ - Follow security headers and encryption requirements
380
+
381
+ 5. **When deploying:**
382
+ - Follow procedures in `docs/operations.md`
383
+ - Update configuration per environment
384
+ - Check health endpoints
385
+
386
+ ---
387
+
388
+ ## 🛠️ Tool-Specific Configurations
389
+
390
+ Different AI tools have specific configuration files that extend this AGENT.md:
391
+
392
+ ### Claude Code
393
+
394
+ - **File:** `.clauderules`
395
+ - **Purpose:** Claude-specific instructions and preferences
396
+ - **References:** This AGENT.md + project docs
397
+
398
+ ### Cursor
399
+
400
+ - **File:** `.cursorrules`
401
+ - **Purpose:** Cursor-specific context and rules
402
+ - **References:** This AGENT.md + project docs
403
+
404
+ ### GitHub Copilot
405
+
406
+ - **File:** `.github/copilot-instructions.md`
407
+ - **Purpose:** Copilot workspace instructions
408
+ - **References:** This AGENT.md + project docs
409
+
410
+ ## **All tool-specific configs reference this AGENT.md as the source of truth.**
411
+
412
+ ## 📊 Project Status
413
+
414
+ **Current Phase:** {{PROJECT_PHASE}}
415
+
416
+ **Architecture:** {{ARCHITECTURE_PATTERN}}
417
+
418
+ ## **Compliance:** {{COMPLIANCE_REQUIREMENTS}}
419
+
420
+ ## 🚀 Getting Started
421
+
422
+ ### For AI Assistants
423
+
424
+ 1. Read this AGENT.md completely
425
+ 2. Read `ai-instructions.md` for critical rules
426
+ 3. Familiarize with `docs/architecture.md`
427
+ 4. Review `docs/code-standards.md` for coding patterns
428
+ 5. Check `specs/security.md` before handling auth/sensitive data
429
+
430
+ ### For Developers
431
+
432
+ ## See `README.md` for installation and setup instructions.
433
+
434
+ ## 📝 Document Update Policy
435
+
436
+ - Documents are **living artifacts** - update as project evolves
437
+ - Breaking changes to architecture → Update `docs/architecture.md`
438
+ - New security requirements → Update `specs/security.md`
439
+ - Stack changes → Update `ai-instructions.md` AND this AGENT.md
440
+
441
+ **Last Updated:** {{GENERATION_DATE}}
442
+
443
+ **Generated by:** AI Flow v2.8.0