proagents 1.6.17 → 1.6.19

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 (185) hide show
  1. package/.claude/settings.local.json +169 -0
  2. package/.proagents/AGENTS.md +2 -0
  3. package/.proagents/AI_INSTRUCTIONS.md +13 -0
  4. package/.proagents/ANTIGRAVITY.md +2 -0
  5. package/.proagents/BOLT.md +2 -0
  6. package/.proagents/CHATGPT.md +2 -0
  7. package/.proagents/CLAUDE.md +2 -0
  8. package/.proagents/GEMINI.md +2 -0
  9. package/.proagents/GROQ.md +2 -0
  10. package/.proagents/KIRO.md +2 -0
  11. package/.proagents/LOVABLE.md +2 -0
  12. package/.proagents/PROAGENTS.md +2 -0
  13. package/.proagents/REPLIT.md +2 -0
  14. package/.proagents/prompts/00-project-setup.md +878 -0
  15. package/.proagents/prompts/04-planning.md +38 -0
  16. package/.proagents/prompts/12-rnd.md +957 -0
  17. package/.proagents/workflow-modes/entry-modes.md +27 -0
  18. package/.proagents/worklog/_context.template.md +47 -0
  19. package/COMMANDS.md +654 -0
  20. package/README.md +16 -24
  21. package/package.json +2 -7
  22. package/.proagents/ai-models/README.md +0 -141
  23. package/.proagents/ai-models/cost-management.md +0 -362
  24. package/.proagents/ai-models/fallbacks.md +0 -342
  25. package/.proagents/ai-models/model-config.md +0 -318
  26. package/.proagents/ai-models/task-routing.md +0 -503
  27. package/.proagents/ai-training/README.md +0 -155
  28. package/.proagents/ai-training/continuous-learning.md +0 -413
  29. package/.proagents/ai-training/domain-knowledge.md +0 -378
  30. package/.proagents/ai-training/pattern-learning.md +0 -455
  31. package/.proagents/ai-training/training-data.md +0 -337
  32. package/.proagents/ai-training/user-preferences.md +0 -346
  33. package/.proagents/approval-workflows/README.md +0 -146
  34. package/.proagents/approval-workflows/approval-config.md +0 -332
  35. package/.proagents/approval-workflows/approval-stages.md +0 -503
  36. package/.proagents/approval-workflows/emergency-bypass.md +0 -351
  37. package/.proagents/approval-workflows/examples.md +0 -859
  38. package/.proagents/approval-workflows/notifications.md +0 -320
  39. package/.proagents/compliance/README.md +0 -206
  40. package/.proagents/compliance/access-control.md +0 -310
  41. package/.proagents/compliance/audit-logging.md +0 -444
  42. package/.proagents/compliance/compliance-frameworks.md +0 -429
  43. package/.proagents/compliance/reports.md +0 -491
  44. package/.proagents/compliance/retention-policies.md +0 -454
  45. package/.proagents/config-versioning/README.md +0 -120
  46. package/.proagents/config-versioning/changelog.md +0 -300
  47. package/.proagents/config-versioning/rollback.md +0 -283
  48. package/.proagents/config-versioning/versioning.md +0 -330
  49. package/.proagents/contract-testing/README.md +0 -223
  50. package/.proagents/contract-testing/contract-testing.md +0 -614
  51. package/.proagents/contract-testing/pact-integration.md +0 -507
  52. package/.proagents/contract-testing/schema-validation.md +0 -565
  53. package/.proagents/dependency-management/README.md +0 -140
  54. package/.proagents/dependency-management/automation.md +0 -363
  55. package/.proagents/dependency-management/compatibility.md +0 -319
  56. package/.proagents/dependency-management/security-scanning.md +0 -413
  57. package/.proagents/dependency-management/update-policies.md +0 -374
  58. package/.proagents/disaster-recovery/README.md +0 -247
  59. package/.proagents/disaster-recovery/automation.md +0 -366
  60. package/.proagents/disaster-recovery/backup-recovery.md +0 -571
  61. package/.proagents/disaster-recovery/incident-response.md +0 -565
  62. package/.proagents/disaster-recovery/rollback-procedures.md +0 -499
  63. package/.proagents/disaster-recovery/runbooks.md +0 -603
  64. package/.proagents/disaster-recovery/scenarios.md +0 -892
  65. package/.proagents/disaster-recovery/testing.md +0 -438
  66. package/.proagents/environments/README.md +0 -244
  67. package/.proagents/environments/configuration.md +0 -437
  68. package/.proagents/environments/promotion.md +0 -434
  69. package/.proagents/environments/setup.md +0 -420
  70. package/.proagents/examples/README.md +0 -55
  71. package/.proagents/examples/backend-nodejs/README.md +0 -188
  72. package/.proagents/examples/backend-nodejs/complete-conversation.md +0 -601
  73. package/.proagents/examples/backend-nodejs/proagents.config.yaml +0 -415
  74. package/.proagents/examples/backend-nodejs/workflow-example.md +0 -909
  75. package/.proagents/examples/fullstack-nextjs/README.md +0 -155
  76. package/.proagents/examples/fullstack-nextjs/complete-conversation.md +0 -604
  77. package/.proagents/examples/fullstack-nextjs/proagents.config.yaml +0 -287
  78. package/.proagents/examples/fullstack-nextjs/workflow-example.md +0 -553
  79. package/.proagents/examples/mobile-react-native/README.md +0 -171
  80. package/.proagents/examples/mobile-react-native/complete-conversation.md +0 -825
  81. package/.proagents/examples/mobile-react-native/proagents.config.yaml +0 -330
  82. package/.proagents/examples/mobile-react-native/workflow-example.md +0 -723
  83. package/.proagents/examples/web-frontend-react/README.md +0 -125
  84. package/.proagents/examples/web-frontend-react/complete-conversation.md +0 -556
  85. package/.proagents/examples/web-frontend-react/proagents.config.yaml +0 -183
  86. package/.proagents/examples/web-frontend-react/workflow-example.md +0 -603
  87. package/.proagents/existing-projects/README.md +0 -65
  88. package/.proagents/existing-projects/challenges.md +0 -861
  89. package/.proagents/existing-projects/coexistence-mode.md +0 -483
  90. package/.proagents/existing-projects/compatibility-assessment.md +0 -541
  91. package/.proagents/existing-projects/gradual-adoption.md +0 -515
  92. package/.proagents/existing-projects/migration-strategies.md +0 -788
  93. package/.proagents/existing-projects/pattern-reconciliation.md +0 -489
  94. package/.proagents/existing-projects/team-onboarding.md +0 -617
  95. package/.proagents/existing-projects/technical-debt-handling.md +0 -644
  96. package/.proagents/feature-flags/README.md +0 -263
  97. package/.proagents/feature-flags/ab-testing.md +0 -413
  98. package/.proagents/feature-flags/configuration.md +0 -420
  99. package/.proagents/feature-flags/kill-switches.md +0 -444
  100. package/.proagents/feature-flags/rollout-strategies.md +0 -392
  101. package/.proagents/history.log +0 -12
  102. package/.proagents/i18n/README.md +0 -133
  103. package/.proagents/i18n/extraction.md +0 -433
  104. package/.proagents/i18n/tms-integration.md +0 -332
  105. package/.proagents/i18n/translation-workflow.md +0 -413
  106. package/.proagents/i18n/validation.md +0 -355
  107. package/.proagents/logging/README.md +0 -276
  108. package/.proagents/logging/aggregation.md +0 -475
  109. package/.proagents/logging/log-levels.md +0 -376
  110. package/.proagents/logging/sensitive-data.md +0 -423
  111. package/.proagents/logging/structured-logging.md +0 -406
  112. package/.proagents/metrics/README.md +0 -69
  113. package/.proagents/metrics/code-quality-kpis.md +0 -461
  114. package/.proagents/metrics/deployment-metrics.md +0 -517
  115. package/.proagents/metrics/developer-productivity.md +0 -368
  116. package/.proagents/metrics/learning-effectiveness.md +0 -478
  117. package/.proagents/migrations/README.md +0 -77
  118. package/.proagents/migrations/from-claude-projects.md +0 -313
  119. package/.proagents/migrations/from-cursor-rules.md +0 -345
  120. package/.proagents/migrations/from-custom-workflows.md +0 -410
  121. package/.proagents/monitoring/README.md +0 -308
  122. package/.proagents/monitoring/alerting.md +0 -449
  123. package/.proagents/monitoring/dashboards.md +0 -454
  124. package/.proagents/monitoring/health-checks.md +0 -436
  125. package/.proagents/monitoring/metrics.md +0 -434
  126. package/.proagents/multi-project/README.md +0 -170
  127. package/.proagents/multi-project/coordinated-deploy.md +0 -510
  128. package/.proagents/multi-project/cross-project-deps.md +0 -395
  129. package/.proagents/multi-project/unified-changelog.md +0 -477
  130. package/.proagents/multi-project/walkthroughs/monorepo-setup.md +0 -787
  131. package/.proagents/multi-project/workspace-config.md +0 -408
  132. package/.proagents/notifications/README.md +0 -151
  133. package/.proagents/notifications/channels.md +0 -457
  134. package/.proagents/notifications/preferences.md +0 -415
  135. package/.proagents/notifications/routing.md +0 -449
  136. package/.proagents/notifications/scheduling.md +0 -425
  137. package/.proagents/notifications/templates.md +0 -446
  138. package/.proagents/offline-mode/README.md +0 -145
  139. package/.proagents/offline-mode/caching.md +0 -344
  140. package/.proagents/offline-mode/offline-operations.md +0 -312
  141. package/.proagents/offline-mode/queue-specifications.md +0 -679
  142. package/.proagents/offline-mode/sync.md +0 -475
  143. package/.proagents/parallel-features/README.md +0 -85
  144. package/.proagents/parallel-features/conflict-detection.md +0 -226
  145. package/.proagents/parallel-features/dependency-management.md +0 -392
  146. package/.proagents/parallel-features/merge-coordination.md +0 -506
  147. package/.proagents/parallel-features/tracking-system.md +0 -416
  148. package/.proagents/performance/README.md +0 -59
  149. package/.proagents/performance/bundle-analysis.md +0 -375
  150. package/.proagents/performance/load-testing.md +0 -563
  151. package/.proagents/performance/runtime-metrics.md +0 -489
  152. package/.proagents/performance/web-vitals.md +0 -425
  153. package/.proagents/plugins/README.md +0 -139
  154. package/.proagents/plugins/creating-plugins.md +0 -504
  155. package/.proagents/plugins/plugin-api.md +0 -467
  156. package/.proagents/plugins/plugin-registry.md +0 -276
  157. package/.proagents/reporting/README.md +0 -158
  158. package/.proagents/reporting/dashboards.md +0 -366
  159. package/.proagents/reporting/exports.md +0 -524
  160. package/.proagents/reporting/quality-metrics.md +0 -385
  161. package/.proagents/reporting/templates/README.md +0 -56
  162. package/.proagents/reporting/templates/dashboard-config.json +0 -187
  163. package/.proagents/reporting/templates/metrics-queries.md +0 -427
  164. package/.proagents/reporting/templates/react-dashboard.tsx +0 -544
  165. package/.proagents/reporting/templates/widgets.md +0 -451
  166. package/.proagents/reporting/velocity-metrics.md +0 -340
  167. package/.proagents/reverse-engineering/README.md +0 -151
  168. package/.proagents/reverse-engineering/architecture-extraction.md +0 -325
  169. package/.proagents/reverse-engineering/code-analysis.md +0 -377
  170. package/.proagents/reverse-engineering/dependency-mapping.md +0 -567
  171. package/.proagents/reverse-engineering/diagram-generation.md +0 -586
  172. package/.proagents/reverse-engineering/documentation-generation.md +0 -468
  173. package/.proagents/reverse-engineering/pattern-detection.md +0 -569
  174. package/.proagents/reverse-engineering/quality-assessment.md +0 -733
  175. package/.proagents/secrets/README.md +0 -278
  176. package/.proagents/secrets/access-control.md +0 -443
  177. package/.proagents/secrets/rotation.md +0 -403
  178. package/.proagents/secrets/scanning.md +0 -487
  179. package/.proagents/secrets/storage.md +0 -394
  180. package/.proagents/webhooks/README.md +0 -126
  181. package/.proagents/webhooks/endpoints.md +0 -298
  182. package/.proagents/webhooks/events.md +0 -316
  183. package/.proagents/webhooks/payloads.md +0 -325
  184. package/.proagents/webhooks/reliability.md +0 -363
  185. package/.proagents/webhooks/security.md +0 -380
@@ -1,340 +0,0 @@
1
- # Velocity Metrics
2
-
3
- Track development speed and delivery throughput.
4
-
5
- ---
6
-
7
- ## Overview
8
-
9
- Velocity metrics help understand how fast your team delivers value and identify bottlenecks.
10
-
11
- ---
12
-
13
- ## Key Metrics
14
-
15
- ### Features Per Period
16
-
17
- ```
18
- ┌─────────────────────────────────────────────────────────────┐
19
- │ Features Completed - Last 4 Weeks │
20
- ├─────────────────────────────────────────────────────────────┤
21
- │ │
22
- │ Week 1: ████████████████ 8 │
23
- │ Week 2: ██████████████████████ 11 │
24
- │ Week 3: ████████████████████ 10 │
25
- │ Week 4: ██████████████████████████ 13 │
26
- │ │
27
- │ Average: 10.5 features/week │
28
- │ Trend: ↑ 15% improvement │
29
- │ │
30
- └─────────────────────────────────────────────────────────────┘
31
- ```
32
-
33
- ### Cycle Time
34
-
35
- Time from feature start to completion:
36
-
37
- ```yaml
38
- cycle_time:
39
- current_average: "3.2 days"
40
- trend: "improving"
41
-
42
- by_phase:
43
- analysis: "0.5 days"
44
- requirements: "0.3 days"
45
- design: "0.4 days"
46
- implementation: "1.2 days"
47
- testing: "0.5 days"
48
- review: "0.2 days"
49
- deployment: "0.1 days"
50
-
51
- by_complexity:
52
- low: "1.5 days"
53
- medium: "3.0 days"
54
- high: "5.5 days"
55
- ```
56
-
57
- ### Lead Time
58
-
59
- Time from feature request to production:
60
-
61
- ```yaml
62
- lead_time:
63
- current_average: "5.8 days"
64
-
65
- breakdown:
66
- waiting: "1.5 days" # In backlog
67
- active: "3.2 days" # In development
68
- review: "0.8 days" # In review
69
- deploy: "0.3 days" # To production
70
- ```
71
-
72
- ### Throughput
73
-
74
- ```
75
- ┌─────────────────────────────────────────────────────────────┐
76
- │ Weekly Throughput │
77
- ├─────────────────────────────────────────────────────────────┤
78
- │ │
79
- │ Features: ████████████████████ 10 │
80
- │ Bug Fixes: ████████████████████████████████ 18 │
81
- │ Quick: ████████ 4 │
82
- │ │
83
- │ Total Deliveries: 32 │
84
- │ Deployment Frequency: 4.5/day │
85
- │ │
86
- └─────────────────────────────────────────────────────────────┘
87
- ```
88
-
89
- ---
90
-
91
- ## Velocity Report
92
-
93
- ### Generate Report
94
-
95
- ```bash
96
- # Weekly velocity report
97
- proagents report velocity --period week
98
-
99
- # Monthly velocity report
100
- proagents report velocity --period month
101
-
102
- # Custom date range
103
- proagents report velocity --from 2024-01-01 --to 2024-01-31
104
- ```
105
-
106
- ### Report Output
107
-
108
- ```markdown
109
- # Velocity Report - Week 3, 2024
110
-
111
- ## Summary
112
- - Features Completed: 12 (↑ 20% from last week)
113
- - Bug Fixes: 15
114
- - Quick Changes: 8
115
- - Total Deliveries: 35
116
-
117
- ## Cycle Time
118
- - Average: 3.1 days (↓ 0.3 days improvement)
119
- - Fastest: 0.5 days (config update)
120
- - Slowest: 8.2 days (payment integration)
121
-
122
- ## By Team Member
123
- | Developer | Features | Bug Fixes | Avg Cycle Time |
124
- |-----------|----------|-----------|----------------|
125
- | Dev 1 | 4 | 3 | 2.8 days |
126
- | Dev 2 | 3 | 5 | 3.2 days |
127
- | Dev 3 | 5 | 7 | 3.0 days |
128
-
129
- ## Bottlenecks Identified
130
- 1. Code review taking 25% longer than target
131
- 2. Testing phase delays on complex features
132
-
133
- ## Recommendations
134
- 1. Add second reviewer for faster reviews
135
- 2. Improve test infrastructure
136
- ```
137
-
138
- ---
139
-
140
- ## Tracking Configuration
141
-
142
- ### Metric Collection
143
-
144
- ```yaml
145
- reporting:
146
- velocity:
147
- metrics:
148
- - features_completed
149
- - bug_fixes
150
- - cycle_time
151
- - lead_time
152
- - throughput
153
- - deployment_frequency
154
-
155
- track_by:
156
- - team
157
- - developer
158
- - project
159
- - complexity
160
-
161
- periods:
162
- - daily
163
- - weekly
164
- - monthly
165
- - quarterly
166
- ```
167
-
168
- ### Targets and Thresholds
169
-
170
- ```yaml
171
- velocity:
172
- targets:
173
- cycle_time:
174
- low_complexity: "2 days"
175
- medium_complexity: "4 days"
176
- high_complexity: "8 days"
177
-
178
- features_per_week:
179
- minimum: 5
180
- target: 10
181
- stretch: 15
182
-
183
- deployment_frequency:
184
- minimum: "1/day"
185
- target: "3/day"
186
-
187
- alerts:
188
- - metric: cycle_time
189
- condition: "> 5 days"
190
- action: notify_lead
191
-
192
- - metric: features_per_week
193
- condition: "< 5"
194
- action: schedule_retrospective
195
- ```
196
-
197
- ---
198
-
199
- ## Trend Analysis
200
-
201
- ### Velocity Trends
202
-
203
- ```
204
- ┌─────────────────────────────────────────────────────────────┐
205
- │ Velocity Trend - Last 12 Weeks │
206
- ├─────────────────────────────────────────────────────────────┤
207
- │ │
208
- │ Features │ ● │
209
- │ /Week │ ● ● │
210
- │ │ ● ● ● │
211
- │ 15 ── │ ● │
212
- │ │ ● │
213
- │ 10 ── │ ● │
214
- │ │ │
215
- │ 5 ── │ │
216
- │ └────────────────────────────────────────────────│
217
- │ W1 W2 W3 W4 W5 W6 W7 W8 W9 W10 W11 W12│
218
- │ │
219
- │ Trend: ↑ 25% improvement over 12 weeks │
220
- │ │
221
- └─────────────────────────────────────────────────────────────┘
222
- ```
223
-
224
- ### Predictive Analysis
225
-
226
- ```yaml
227
- predictions:
228
- next_week:
229
- features: "11-13"
230
- confidence: 85%
231
-
232
- quarter_end:
233
- features: "140-160"
234
- on_track: true
235
-
236
- risk_factors:
237
- - "Holiday week may reduce by 30%"
238
- - "New team member ramping up"
239
- ```
240
-
241
- ---
242
-
243
- ## Phase Analysis
244
-
245
- ### Time per Phase
246
-
247
- ```
248
- ┌─────────────────────────────────────────────────────────────┐
249
- │ Average Time per Phase │
250
- ├─────────────────────────────────────────────────────────────┤
251
- │ │
252
- │ Analysis: ████ 0.5 days (target: 0.5) │
253
- │ Requirements: ███ 0.3 days (target: 0.5) │
254
- │ Design: ████ 0.4 days (target: 0.5) │
255
- │ Implementation: ████████████ 1.2 days (target: 1.0) ⚠️ │
256
- │ Testing: █████ 0.5 days (target: 0.5) │
257
- │ Review: ████ 0.4 days (target: 0.3) ⚠️ │
258
- │ Documentation: ██ 0.2 days (target: 0.3) │
259
- │ Deployment: █ 0.1 days (target: 0.2) │
260
- │ │
261
- │ Total: 3.6 days (target: 3.8 days) ✅ │
262
- │ │
263
- └─────────────────────────────────────────────────────────────┘
264
- ```
265
-
266
- ### Bottleneck Detection
267
-
268
- ```yaml
269
- bottlenecks:
270
- detected:
271
- - phase: implementation
272
- delay: "0.2 days over target"
273
- frequency: "60% of features"
274
- cause: "Complex integrations"
275
- recommendation: "Break into smaller tasks"
276
-
277
- - phase: review
278
- delay: "0.1 days over target"
279
- frequency: "40% of features"
280
- cause: "Reviewer availability"
281
- recommendation: "Add backup reviewers"
282
- ```
283
-
284
- ---
285
-
286
- ## Comparison Reports
287
-
288
- ### Team Comparison
289
-
290
- ```bash
291
- proagents report velocity --compare teams
292
- ```
293
-
294
- ```
295
- ┌─────────────────────────────────────────────────────────────┐
296
- │ Team Velocity Comparison │
297
- ├─────────────────────────────────────────────────────────────┤
298
- │ │
299
- │ Team │ Features │ Cycle Time │ Quality │ Score │
300
- │ ────────────┼──────────┼────────────┼─────────┼─────── │
301
- │ Frontend │ 15 │ 2.8 days │ 92% │ ████████ │
302
- │ Backend │ 12 │ 3.5 days │ 88% │ ███████ │
303
- │ Mobile │ 8 │ 4.2 days │ 85% │ ██████ │
304
- │ │
305
- └─────────────────────────────────────────────────────────────┘
306
- ```
307
-
308
- ### Period Comparison
309
-
310
- ```bash
311
- proagents report velocity --compare periods
312
- ```
313
-
314
- ```
315
- ┌─────────────────────────────────────────────────────────────┐
316
- │ Period Comparison: Q4 2023 vs Q1 2024 │
317
- ├─────────────────────────────────────────────────────────────┤
318
- │ │
319
- │ Metric │ Q4 2023 │ Q1 2024 │ Change │
320
- │ ────────────────────┼──────────┼──────────┼────────────── │
321
- │ Features/Week │ 8.5 │ 11.2 │ ↑ 32% │
322
- │ Cycle Time │ 4.2 days │ 3.1 days │ ↓ 26% │
323
- │ Deployment Freq │ 2.1/day │ 3.8/day │ ↑ 81% │
324
- │ Bug Escape Rate │ 8% │ 5% │ ↓ 38% │
325
- │ │
326
- │ Overall Improvement: 34% │
327
- │ │
328
- └─────────────────────────────────────────────────────────────┘
329
- ```
330
-
331
- ---
332
-
333
- ## Best Practices
334
-
335
- 1. **Track Consistently**: Measure the same metrics over time
336
- 2. **Focus on Trends**: Single data points are less meaningful
337
- 3. **Context Matters**: Consider holidays, team changes
338
- 4. **Don't Game Metrics**: Quality over quantity
339
- 5. **Share Results**: Make metrics visible to the team
340
- 6. **Act on Insights**: Use data to drive improvements
@@ -1,151 +0,0 @@
1
- # Reverse Engineering System
2
-
3
- Analyze existing codebases to extract architecture, patterns, and documentation.
4
-
5
- ---
6
-
7
- ## Overview
8
-
9
- Reverse engineering enables ProAgents to:
10
-
11
- - **Understand** existing codebases without documentation
12
- - **Extract** architecture, patterns, and conventions
13
- - **Generate** documentation from code
14
- - **Create** visual diagrams of system structure
15
- - **Map** dependencies and relationships
16
- - **Identify** tech debt and improvement opportunities
17
-
18
- ---
19
-
20
- ## Use Cases
21
-
22
- ### 1. Onboarding to Existing Project
23
- ```
24
- pa:reverse-engineer --full
25
-
26
- Output:
27
- - Complete architecture documentation
28
- - Component relationship diagrams
29
- - API endpoint mapping
30
- - Database schema visualization
31
- - Pattern guide for new developers
32
- ```
33
-
34
- ### 2. Documentation Generation
35
- ```
36
- pa:reverse-engineer --docs
37
-
38
- Output:
39
- - README for each module
40
- - API documentation
41
- - Component documentation
42
- - Architecture decision records
43
- ```
44
-
45
- ### 3. Architecture Understanding
46
- ```
47
- pa:reverse-engineer --architecture
48
-
49
- Output:
50
- - High-level architecture diagram
51
- - Module dependency graph
52
- - Data flow documentation
53
- - Integration points
54
- ```
55
-
56
- ### 4. Code Quality Assessment
57
- ```
58
- pa:reverse-engineer --quality
59
-
60
- Output:
61
- - Tech debt identification
62
- - Code smell detection
63
- - Refactoring opportunities
64
- - Complexity analysis
65
- ```
66
-
67
- ---
68
-
69
- ## Reverse Engineering Phases
70
-
71
- ### Phase 1: Discovery
72
- - Scan all files and directories
73
- - Identify frameworks and languages
74
- - Detect configuration files
75
- - Map project structure
76
-
77
- ### Phase 2: Analysis
78
- - Parse source code
79
- - Extract classes, functions, components
80
- - Map imports and dependencies
81
- - Identify patterns and conventions
82
-
83
- ### Phase 3: Relationship Mapping
84
- - Build dependency graph
85
- - Map component relationships
86
- - Trace data flow
87
- - Identify integration points
88
-
89
- ### Phase 4: Documentation Generation
90
- - Generate architecture docs
91
- - Create API documentation
92
- - Produce component guides
93
- - Build visual diagrams
94
-
95
- ### Phase 5: Insight Extraction
96
- - Identify patterns used
97
- - Extract conventions
98
- - Detect anti-patterns
99
- - Suggest improvements
100
-
101
- ---
102
-
103
- ## Quick Start
104
-
105
- ```bash
106
- # Full reverse engineering
107
- pa:reverse-engineer
108
-
109
- # Specific scope
110
- pa:reverse-engineer --scope architecture
111
- pa:reverse-engineer --scope api
112
- pa:reverse-engineer --scope components
113
- pa:reverse-engineer --scope database
114
-
115
- # Output format
116
- pa:reverse-engineer --format markdown
117
- pa:reverse-engineer --format html
118
- pa:reverse-engineer --format json
119
-
120
- # Specific path
121
- pa:reverse-engineer --path ./src/modules/auth
122
- ```
123
-
124
- ---
125
-
126
- ## Files in This Section
127
-
128
- | File | Description |
129
- |------|-------------|
130
- | `README.md` | This overview |
131
- | `architecture-extraction.md` | How to extract architecture |
132
- | `code-analysis.md` | Deep code analysis guide |
133
- | `documentation-generation.md` | Auto-generate docs from code |
134
- | `diagram-generation.md` | Generate visual diagrams |
135
- | `pattern-detection.md` | Detect patterns and conventions |
136
- | `dependency-mapping.md` | Map dependencies |
137
- | `quality-assessment.md` | Code quality analysis |
138
-
139
- ---
140
-
141
- ## Commands
142
-
143
- | Command | Description |
144
- |---------|-------------|
145
- | `pa:reverse-engineer` | Full reverse engineering |
146
- | `pa:re-architecture` | Extract architecture only |
147
- | `pa:re-docs` | Generate documentation |
148
- | `pa:re-diagrams` | Generate diagrams |
149
- | `pa:re-patterns` | Detect patterns |
150
- | `pa:re-deps` | Map dependencies |
151
- | `pa:re-quality` | Quality assessment |