@su-record/vibe 2.7.14 → 2.7.15

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 (229) hide show
  1. package/.env.example +37 -37
  2. package/CLAUDE.md +134 -126
  3. package/LICENSE +21 -21
  4. package/README.md +449 -449
  5. package/agents/architect-low.md +41 -41
  6. package/agents/architect-medium.md +59 -59
  7. package/agents/architect.md +80 -80
  8. package/agents/build-error-resolver.md +115 -115
  9. package/agents/compounder.md +261 -261
  10. package/agents/diagrammer.md +178 -178
  11. package/agents/docs/api-documenter.md +99 -99
  12. package/agents/docs/changelog-writer.md +93 -93
  13. package/agents/e2e-tester.md +294 -294
  14. package/agents/explorer-low.md +42 -42
  15. package/agents/explorer-medium.md +59 -59
  16. package/agents/explorer.md +48 -48
  17. package/agents/implementer-low.md +43 -43
  18. package/agents/implementer-medium.md +52 -52
  19. package/agents/implementer.md +54 -54
  20. package/agents/junior-mentor.md +141 -141
  21. package/agents/planning/requirements-analyst.md +84 -84
  22. package/agents/planning/ux-advisor.md +83 -83
  23. package/agents/qa/acceptance-tester.md +86 -86
  24. package/agents/qa/edge-case-finder.md +93 -93
  25. package/agents/refactor-cleaner.md +143 -143
  26. package/agents/research/best-practices-agent.md +199 -199
  27. package/agents/research/codebase-patterns-agent.md +157 -157
  28. package/agents/research/framework-docs-agent.md +188 -188
  29. package/agents/research/security-advisory-agent.md +213 -213
  30. package/agents/review/architecture-reviewer.md +107 -107
  31. package/agents/review/complexity-reviewer.md +116 -116
  32. package/agents/review/data-integrity-reviewer.md +88 -88
  33. package/agents/review/git-history-reviewer.md +103 -103
  34. package/agents/review/performance-reviewer.md +86 -86
  35. package/agents/review/python-reviewer.md +150 -150
  36. package/agents/review/rails-reviewer.md +139 -139
  37. package/agents/review/react-reviewer.md +144 -144
  38. package/agents/review/security-reviewer.md +80 -80
  39. package/agents/review/simplicity-reviewer.md +140 -140
  40. package/agents/review/test-coverage-reviewer.md +116 -116
  41. package/agents/review/typescript-reviewer.md +127 -127
  42. package/agents/searcher.md +54 -54
  43. package/agents/simplifier.md +120 -120
  44. package/agents/tester.md +49 -49
  45. package/agents/ui/ui-a11y-auditor.md +93 -93
  46. package/agents/ui/ui-antipattern-detector.md +94 -94
  47. package/agents/ui/ui-dataviz-advisor.md +69 -69
  48. package/agents/ui/ui-design-system-gen.md +57 -57
  49. package/agents/ui/ui-industry-analyzer.md +49 -49
  50. package/agents/ui/ui-layout-architect.md +65 -65
  51. package/agents/ui/ui-stack-implementer.md +68 -68
  52. package/agents/ui/ux-compliance-reviewer.md +81 -81
  53. package/agents/ui-previewer.md +258 -258
  54. package/commands/vibe.analyze.md +11 -13
  55. package/commands/vibe.review.md +43 -1
  56. package/commands/vibe.run.md +2124 -2078
  57. package/commands/vibe.spec.md +9 -4
  58. package/commands/vibe.spec.review.md +569 -565
  59. package/commands/vibe.utils.md +413 -413
  60. package/commands/vibe.verify.md +33 -8
  61. package/dist/cli/collaborator.js +52 -52
  62. package/dist/cli/commands/evolution.js +12 -12
  63. package/dist/cli/commands/info.js +54 -54
  64. package/dist/cli/commands/init.js +5 -5
  65. package/dist/cli/commands/remove.js +14 -14
  66. package/dist/cli/commands/sentinel.js +27 -27
  67. package/dist/cli/commands/skills.js +5 -5
  68. package/dist/cli/commands/slack.js +10 -10
  69. package/dist/cli/commands/telegram.js +12 -12
  70. package/dist/cli/detect.js +32 -32
  71. package/dist/cli/index.js +51 -51
  72. package/dist/cli/llm/claude-commands.js +16 -16
  73. package/dist/cli/llm/config.js +18 -18
  74. package/dist/cli/llm/gemini-commands.js +16 -16
  75. package/dist/cli/llm/gpt-commands.js +19 -19
  76. package/dist/cli/llm/help.js +21 -21
  77. package/dist/cli/postinstall/cursor-agents.js +32 -32
  78. package/dist/cli/postinstall/cursor-rules.js +83 -83
  79. package/dist/cli/postinstall/cursor-skills.js +743 -743
  80. package/dist/cli/setup/Provisioner.js +42 -42
  81. package/dist/infra/lib/DeepInit.js +24 -24
  82. package/dist/infra/lib/IterationTracker.js +11 -11
  83. package/dist/infra/lib/PythonParser.js +108 -108
  84. package/dist/infra/lib/ReviewRace.js +96 -96
  85. package/dist/infra/lib/SkillFrontmatter.js +28 -28
  86. package/dist/infra/lib/SkillQualityGate.js +9 -9
  87. package/dist/infra/lib/SkillRepository.js +159 -159
  88. package/dist/infra/lib/UltraQA.js +99 -99
  89. package/dist/infra/lib/autonomy/AuditStore.js +41 -41
  90. package/dist/infra/lib/autonomy/ConfirmationStore.js +30 -30
  91. package/dist/infra/lib/autonomy/EventOutbox.js +38 -38
  92. package/dist/infra/lib/autonomy/PolicyEngine.js +18 -18
  93. package/dist/infra/lib/autonomy/SecuritySentinel.js +1 -1
  94. package/dist/infra/lib/autonomy/SuggestionStore.js +33 -33
  95. package/dist/infra/lib/embedding/VectorStore.js +22 -22
  96. package/dist/infra/lib/evolution/AgentAnalyzer.js +10 -10
  97. package/dist/infra/lib/evolution/DescriptionOptimizer.js +21 -21
  98. package/dist/infra/lib/evolution/GenerationRegistry.js +36 -36
  99. package/dist/infra/lib/evolution/InsightStore.js +90 -90
  100. package/dist/infra/lib/evolution/RollbackManager.js +5 -5
  101. package/dist/infra/lib/evolution/SkillBenchmark.js +23 -23
  102. package/dist/infra/lib/evolution/SkillEvalRunner.js +50 -50
  103. package/dist/infra/lib/evolution/SkillGapDetector.js +10 -10
  104. package/dist/infra/lib/evolution/UsageTracker.js +28 -28
  105. package/dist/infra/lib/gemini/orchestration.js +5 -5
  106. package/dist/infra/lib/gpt/orchestration.js +4 -4
  107. package/dist/infra/lib/memory/KnowledgeGraph.js +4 -4
  108. package/dist/infra/lib/memory/MemorySearch.js +57 -57
  109. package/dist/infra/lib/memory/MemoryStorage.js +181 -181
  110. package/dist/infra/lib/memory/ObservationStore.js +28 -28
  111. package/dist/infra/lib/memory/ReflectionStore.js +30 -30
  112. package/dist/infra/lib/memory/SessionRAGRetriever.js +7 -7
  113. package/dist/infra/lib/memory/SessionRAGStore.js +225 -225
  114. package/dist/infra/lib/memory/SessionSummarizer.js +9 -9
  115. package/dist/infra/orchestrator/AgentManager.js +12 -12
  116. package/dist/infra/orchestrator/AgentRegistry.js +65 -65
  117. package/dist/infra/orchestrator/MultiLlmResearch.js +8 -8
  118. package/dist/infra/orchestrator/SwarmOrchestrator.test.js +16 -16
  119. package/dist/infra/orchestrator/parallelResearch.js +24 -24
  120. package/dist/tools/convention/analyzeComplexity.test.js +115 -115
  121. package/dist/tools/convention/validateCodeQuality.test.js +104 -104
  122. package/dist/tools/memory/createMemoryTimeline.js +10 -10
  123. package/dist/tools/memory/getMemoryGraph.js +12 -12
  124. package/dist/tools/memory/getSessionContext.js +9 -9
  125. package/dist/tools/memory/linkMemories.js +14 -14
  126. package/dist/tools/memory/listMemories.js +4 -4
  127. package/dist/tools/memory/recallMemory.js +4 -4
  128. package/dist/tools/memory/saveMemory.js +4 -4
  129. package/dist/tools/memory/searchMemoriesAdvanced.js +23 -23
  130. package/dist/tools/semantic/analyzeDependencyGraph.js +12 -12
  131. package/dist/tools/semantic/astGrep.test.js +6 -6
  132. package/dist/tools/spec/prdParser.test.js +171 -171
  133. package/dist/tools/spec/specGenerator.js +169 -169
  134. package/dist/tools/spec/traceabilityMatrix.js +64 -64
  135. package/dist/tools/spec/traceabilityMatrix.test.js +28 -28
  136. package/hooks/gemini-hooks.json +73 -73
  137. package/hooks/hooks.json +137 -137
  138. package/hooks/scripts/code-check.js +77 -70
  139. package/hooks/scripts/context-save.js +212 -212
  140. package/hooks/scripts/hud-status.js +291 -291
  141. package/hooks/scripts/keyword-detector.js +214 -214
  142. package/hooks/scripts/llm-orchestrate.js +475 -475
  143. package/hooks/scripts/post-edit.js +32 -32
  144. package/hooks/scripts/pre-tool-guard.js +125 -125
  145. package/hooks/scripts/prompt-dispatcher.js +185 -185
  146. package/hooks/scripts/sentinel-guard.js +104 -104
  147. package/hooks/scripts/session-start.js +106 -106
  148. package/hooks/scripts/stop-notify.js +209 -209
  149. package/hooks/scripts/utils.js +100 -100
  150. package/languages/csharp-unity.md +515 -515
  151. package/languages/gdscript-godot.md +470 -470
  152. package/languages/ruby-rails.md +489 -489
  153. package/languages/typescript-angular.md +433 -433
  154. package/languages/typescript-astro.md +416 -416
  155. package/languages/typescript-electron.md +406 -406
  156. package/languages/typescript-nestjs.md +524 -524
  157. package/languages/typescript-svelte.md +407 -407
  158. package/languages/typescript-tauri.md +365 -365
  159. package/package.json +121 -121
  160. package/skills/agents-md/SKILL.md +120 -120
  161. package/skills/arch-guard/SKILL.md +180 -180
  162. package/skills/brand-assets/SKILL.md +146 -146
  163. package/skills/capability-loop/SKILL.md +167 -167
  164. package/skills/characterization-test/SKILL.md +206 -206
  165. package/skills/commerce-patterns/SKILL.md +59 -59
  166. package/skills/commit-push-pr/SKILL.md +75 -75
  167. package/skills/context7-usage/SKILL.md +105 -105
  168. package/skills/core-capabilities/SKILL.md +48 -48
  169. package/skills/e2e-commerce/SKILL.md +57 -57
  170. package/skills/exec-plan/SKILL.md +147 -147
  171. package/skills/frontend-design/SKILL.md +73 -73
  172. package/skills/git-worktree/SKILL.md +72 -72
  173. package/skills/handoff/SKILL.md +109 -109
  174. package/skills/parallel-research/SKILL.md +87 -87
  175. package/skills/priority-todos/SKILL.md +63 -63
  176. package/skills/seo-checklist/SKILL.md +57 -57
  177. package/skills/techdebt/SKILL.md +122 -122
  178. package/skills/tool-fallback/SKILL.md +103 -103
  179. package/skills/typescript-advanced-types/SKILL.md +66 -66
  180. package/skills/ui-ux-pro-max/SKILL.md +206 -206
  181. package/skills/vercel-react-best-practices/SKILL.md +59 -59
  182. package/skills/video-production/SKILL.md +51 -51
  183. package/vibe/config.json +29 -29
  184. package/vibe/constitution.md +227 -227
  185. package/vibe/rules/principles/communication-guide.md +98 -98
  186. package/vibe/rules/principles/development-philosophy.md +52 -52
  187. package/vibe/rules/principles/quick-start.md +102 -102
  188. package/vibe/rules/quality/bdd-contract-testing.md +393 -393
  189. package/vibe/rules/quality/checklist.md +276 -276
  190. package/vibe/rules/quality/performance.md +236 -236
  191. package/vibe/rules/quality/testing-strategy.md +440 -440
  192. package/vibe/rules/standards/anti-patterns.md +541 -541
  193. package/vibe/rules/standards/code-structure.md +291 -291
  194. package/vibe/rules/standards/complexity-metrics.md +313 -313
  195. package/vibe/rules/standards/git-workflow.md +237 -237
  196. package/vibe/rules/standards/naming-conventions.md +198 -198
  197. package/vibe/rules/standards/security.md +305 -305
  198. package/vibe/rules/writing/document-style.md +74 -74
  199. package/vibe/setup.sh +31 -31
  200. package/vibe/templates/constitution-template.md +252 -252
  201. package/vibe/templates/contract-backend-template.md +526 -526
  202. package/vibe/templates/contract-frontend-template.md +599 -599
  203. package/vibe/templates/feature-template.md +96 -96
  204. package/vibe/templates/spec-template.md +221 -221
  205. package/vibe/ui-ux-data/charts.csv +26 -26
  206. package/vibe/ui-ux-data/colors.csv +97 -97
  207. package/vibe/ui-ux-data/icons.csv +101 -101
  208. package/vibe/ui-ux-data/landing.csv +31 -31
  209. package/vibe/ui-ux-data/products.csv +96 -96
  210. package/vibe/ui-ux-data/react-performance.csv +45 -45
  211. package/vibe/ui-ux-data/stacks/astro.csv +54 -54
  212. package/vibe/ui-ux-data/stacks/flutter.csv +53 -53
  213. package/vibe/ui-ux-data/stacks/html-tailwind.csv +56 -56
  214. package/vibe/ui-ux-data/stacks/jetpack-compose.csv +53 -53
  215. package/vibe/ui-ux-data/stacks/nextjs.csv +53 -53
  216. package/vibe/ui-ux-data/stacks/nuxt-ui.csv +51 -51
  217. package/vibe/ui-ux-data/stacks/nuxtjs.csv +59 -59
  218. package/vibe/ui-ux-data/stacks/react-native.csv +52 -52
  219. package/vibe/ui-ux-data/stacks/react.csv +54 -54
  220. package/vibe/ui-ux-data/stacks/shadcn.csv +61 -61
  221. package/vibe/ui-ux-data/stacks/svelte.csv +54 -54
  222. package/vibe/ui-ux-data/stacks/swiftui.csv +51 -51
  223. package/vibe/ui-ux-data/stacks/vue.csv +50 -50
  224. package/vibe/ui-ux-data/styles.csv +68 -68
  225. package/vibe/ui-ux-data/typography.csv +57 -57
  226. package/vibe/ui-ux-data/ui-reasoning.csv +101 -101
  227. package/vibe/ui-ux-data/ux-guidelines.csv +99 -99
  228. package/vibe/ui-ux-data/version.json +31 -31
  229. package/vibe/ui-ux-data/web-interface.csv +31 -31
@@ -1,178 +1,178 @@
1
- ---
2
- description: Generate diagrams (architecture, ERD, flowchart)
3
- argument-hint: --er or --flow (optional)
4
- ---
5
-
6
- # /vibe.diagram
7
-
8
- Generate diagrams (architecture, ERD, flowchart).
9
-
10
- ## Usage
11
-
12
- ```
13
- /vibe.diagram
14
- /vibe.diagram --er
15
- /vibe.diagram --flow
16
- ```
17
-
18
- ## Process
19
-
20
- ### 1. Determine Diagram Type
21
-
22
- - **Default** (`/vibe.diagram`): Architecture diagram
23
- - **--er**: ERD (Entity-Relationship Diagram)
24
- - **--flow**: Flowchart (main processes)
25
-
26
- ### 2. Project Analysis
27
-
28
- #### Architecture Diagram
29
- - Understand project structure (folder structure)
30
- - Identify major modules and layers
31
- - Analyze dependency relationships
32
-
33
- #### ERD
34
- - Find database schema files
35
- - `backend/models/`
36
- - `migrations/`
37
- - `schema.sql`
38
- - Identify table relationships
39
-
40
- #### Flowchart
41
- - Main business logic flows
42
- - User action → System response
43
-
44
- ### 3. Generate Mermaid Code
45
-
46
- Generate diagram as ASCII art or Mermaid code:
47
-
48
- #### Architecture Diagram (Mermaid)
49
-
50
- ```mermaid
51
- graph TB
52
- Client[React Frontend]
53
- API[FastAPI Backend]
54
- DB[(PostgreSQL)]
55
- Cache[(Redis)]
56
-
57
- Client -->|HTTP| API
58
- API -->|Query| DB
59
- API -->|Cache| Cache
60
- ```
61
-
62
- #### ERD (Mermaid)
63
-
64
- ```mermaid
65
- erDiagram
66
- USER ||--o{ FEED : creates
67
- USER ||--o{ FOLLOW : follows
68
- FEED }o--|| RESTAURANT : references
69
-
70
- USER {
71
- uuid id PK
72
- string email
73
- int tier
74
- }
75
- FEED {
76
- uuid id PK
77
- uuid user_id FK
78
- uuid restaurant_id FK
79
- text content
80
- }
81
- ```
82
-
83
- #### Flowchart (Mermaid)
84
-
85
- ```mermaid
86
- flowchart TD
87
- Start([User writes feed])
88
- GPS{GPS Auth}
89
- Vision{Vision API Verify}
90
- OCR{OCR Auth}
91
- Save[Save Feed]
92
-
93
- Start --> GPS
94
- GPS -->|Within 50m| Vision
95
- GPS -->|Out of range| Fail
96
- Vision -->|Food detected| OCR
97
- Vision -->|Failed| Fail
98
- OCR -->|Optional| Save
99
- Save --> End([Complete])
100
- ```
101
-
102
- ### 4. Rendering Guide
103
-
104
- Guide on how to render generated Mermaid code:
105
-
106
- - **GitHub**: Paste in `.md` file (auto-renders)
107
- - **VSCode**: Install Mermaid extension
108
- - **Online**: https://mermaid.live/
109
-
110
- ## Example
111
-
112
- ```
113
- User: /vibe.diagram --er
114
-
115
- Claude: Generating ERD...
116
-
117
- Analyzing project...
118
- - Database schema found: backend/models/
119
- - Tables: 15
120
- - Key relationships: USER, FEED, RESTAURANT
121
-
122
- ✅ ERD generation complete!
123
-
124
- ```mermaid
125
- erDiagram
126
- USER ||--o{ FEED : creates
127
- USER ||--o{ FOLLOW : "follows/followed_by"
128
- USER ||--o{ BOOKMARK : bookmarks
129
- FEED }o--|| RESTAURANT : references
130
- FEED ||--o{ COMMENT : has
131
- FEED ||--o{ LIKE : has
132
-
133
- USER {
134
- uuid id PK
135
- string email UK
136
- string username UK
137
- int tier
138
- int points
139
- timestamp created_at
140
- }
141
-
142
- FEED {
143
- uuid id PK
144
- uuid user_id FK
145
- uuid restaurant_id FK
146
- text content
147
- geography location
148
- boolean ocr_verified
149
- timestamp created_at
150
- }
151
-
152
- RESTAURANT {
153
- uuid id PK
154
- string name
155
- geography location
156
- string category
157
- timestamp created_at
158
- }
159
- ```
160
-
161
- **Diagram save location:**
162
- .claude/vibe/diagrams/erd-2025-11-17.md
163
-
164
- **Rendering options:**
165
- 1. Push to GitHub (auto-renders)
166
- 2. Use Mermaid extension in VSCode
167
- 3. View at https://mermaid.live/
168
- ```
169
-
170
- ## Notes
171
-
172
- - Mermaid is supported in GitHub, GitLab, VSCode, etc.
173
- - Complex diagrams may need manual adjustments
174
- - Generated diagrams are saved in `.claude/vibe/diagrams/` folder
175
-
176
- ---
177
-
178
- ARGUMENTS: $ARGUMENTS
1
+ ---
2
+ description: Generate diagrams (architecture, ERD, flowchart)
3
+ argument-hint: --er or --flow (optional)
4
+ ---
5
+
6
+ # /vibe.diagram
7
+
8
+ Generate diagrams (architecture, ERD, flowchart).
9
+
10
+ ## Usage
11
+
12
+ ```
13
+ /vibe.diagram
14
+ /vibe.diagram --er
15
+ /vibe.diagram --flow
16
+ ```
17
+
18
+ ## Process
19
+
20
+ ### 1. Determine Diagram Type
21
+
22
+ - **Default** (`/vibe.diagram`): Architecture diagram
23
+ - **--er**: ERD (Entity-Relationship Diagram)
24
+ - **--flow**: Flowchart (main processes)
25
+
26
+ ### 2. Project Analysis
27
+
28
+ #### Architecture Diagram
29
+ - Understand project structure (folder structure)
30
+ - Identify major modules and layers
31
+ - Analyze dependency relationships
32
+
33
+ #### ERD
34
+ - Find database schema files
35
+ - `backend/models/`
36
+ - `migrations/`
37
+ - `schema.sql`
38
+ - Identify table relationships
39
+
40
+ #### Flowchart
41
+ - Main business logic flows
42
+ - User action → System response
43
+
44
+ ### 3. Generate Mermaid Code
45
+
46
+ Generate diagram as ASCII art or Mermaid code:
47
+
48
+ #### Architecture Diagram (Mermaid)
49
+
50
+ ```mermaid
51
+ graph TB
52
+ Client[React Frontend]
53
+ API[FastAPI Backend]
54
+ DB[(PostgreSQL)]
55
+ Cache[(Redis)]
56
+
57
+ Client -->|HTTP| API
58
+ API -->|Query| DB
59
+ API -->|Cache| Cache
60
+ ```
61
+
62
+ #### ERD (Mermaid)
63
+
64
+ ```mermaid
65
+ erDiagram
66
+ USER ||--o{ FEED : creates
67
+ USER ||--o{ FOLLOW : follows
68
+ FEED }o--|| RESTAURANT : references
69
+
70
+ USER {
71
+ uuid id PK
72
+ string email
73
+ int tier
74
+ }
75
+ FEED {
76
+ uuid id PK
77
+ uuid user_id FK
78
+ uuid restaurant_id FK
79
+ text content
80
+ }
81
+ ```
82
+
83
+ #### Flowchart (Mermaid)
84
+
85
+ ```mermaid
86
+ flowchart TD
87
+ Start([User writes feed])
88
+ GPS{GPS Auth}
89
+ Vision{Vision API Verify}
90
+ OCR{OCR Auth}
91
+ Save[Save Feed]
92
+
93
+ Start --> GPS
94
+ GPS -->|Within 50m| Vision
95
+ GPS -->|Out of range| Fail
96
+ Vision -->|Food detected| OCR
97
+ Vision -->|Failed| Fail
98
+ OCR -->|Optional| Save
99
+ Save --> End([Complete])
100
+ ```
101
+
102
+ ### 4. Rendering Guide
103
+
104
+ Guide on how to render generated Mermaid code:
105
+
106
+ - **GitHub**: Paste in `.md` file (auto-renders)
107
+ - **VSCode**: Install Mermaid extension
108
+ - **Online**: https://mermaid.live/
109
+
110
+ ## Example
111
+
112
+ ```
113
+ User: /vibe.diagram --er
114
+
115
+ Claude: Generating ERD...
116
+
117
+ Analyzing project...
118
+ - Database schema found: backend/models/
119
+ - Tables: 15
120
+ - Key relationships: USER, FEED, RESTAURANT
121
+
122
+ ✅ ERD generation complete!
123
+
124
+ ```mermaid
125
+ erDiagram
126
+ USER ||--o{ FEED : creates
127
+ USER ||--o{ FOLLOW : "follows/followed_by"
128
+ USER ||--o{ BOOKMARK : bookmarks
129
+ FEED }o--|| RESTAURANT : references
130
+ FEED ||--o{ COMMENT : has
131
+ FEED ||--o{ LIKE : has
132
+
133
+ USER {
134
+ uuid id PK
135
+ string email UK
136
+ string username UK
137
+ int tier
138
+ int points
139
+ timestamp created_at
140
+ }
141
+
142
+ FEED {
143
+ uuid id PK
144
+ uuid user_id FK
145
+ uuid restaurant_id FK
146
+ text content
147
+ geography location
148
+ boolean ocr_verified
149
+ timestamp created_at
150
+ }
151
+
152
+ RESTAURANT {
153
+ uuid id PK
154
+ string name
155
+ geography location
156
+ string category
157
+ timestamp created_at
158
+ }
159
+ ```
160
+
161
+ **Diagram save location:**
162
+ .claude/vibe/diagrams/erd-2025-11-17.md
163
+
164
+ **Rendering options:**
165
+ 1. Push to GitHub (auto-renders)
166
+ 2. Use Mermaid extension in VSCode
167
+ 3. View at https://mermaid.live/
168
+ ```
169
+
170
+ ## Notes
171
+
172
+ - Mermaid is supported in GitHub, GitLab, VSCode, etc.
173
+ - Complex diagrams may need manual adjustments
174
+ - Generated diagrams are saved in `.claude/vibe/diagrams/` folder
175
+
176
+ ---
177
+
178
+ ARGUMENTS: $ARGUMENTS
@@ -1,99 +1,99 @@
1
- # API Documenter
2
-
3
- <!-- API Documentation Generation Agent -->
4
-
5
- ## Role
6
-
7
- - Analyze source code to extract API endpoints and interfaces
8
- - Generate structured API documentation (request/response schemas)
9
- - Identify undocumented endpoints and missing descriptions
10
- - Verify error response documentation completeness
11
- - Check authentication requirement documentation
12
-
13
- ## Model
14
-
15
- **Haiku** (inherit) - Fast analysis
16
-
17
- ## CRITICAL: NO FILE CREATION
18
-
19
- **THIS AGENT MUST NEVER CREATE FILES.**
20
-
21
- - DO NOT use Write tool
22
- - DO NOT create any files
23
- - ONLY return documentation as text output
24
- - Results can be used by other tools to generate files
25
-
26
- ## Checklist
27
-
28
- ### Endpoint Coverage
29
-
30
- - [ ] All route handlers/controllers documented?
31
- - [ ] HTTP method and path clearly specified?
32
- - [ ] Request parameters (path, query, body) described?
33
- - [ ] Response schemas for success and error cases?
34
- - [ ] Authentication requirements noted?
35
-
36
- ### Schema Quality
37
-
38
- - [ ] All fields have types and descriptions?
39
- - [ ] Required vs optional fields marked?
40
- - [ ] Enum values listed?
41
- - [ ] Nested objects described?
42
- - [ ] Array item types specified?
43
-
44
- ### Error Documentation
45
-
46
- - [ ] All error status codes documented?
47
- - [ ] Error response format specified?
48
- - [ ] Common error scenarios listed?
49
- - [ ] Rate limiting documented (if applicable)?
50
-
51
- ### Examples
52
-
53
- - [ ] Request examples for each endpoint?
54
- - [ ] Response examples (success + error)?
55
- - [ ] cURL or fetch examples?
56
-
57
- ## Output Format
58
-
59
- ```markdown
60
- ## API Documentation: {feature/module name}
61
-
62
- ### Endpoints Found: {N}
63
- ### Undocumented: {N}
64
-
65
- ### Endpoint: {METHOD} {path}
66
-
67
- **Authentication**: {required/optional/none}
68
-
69
- **Parameters**:
70
- | Name | In | Type | Required | Description |
71
- |------|----|------|----------|-------------|
72
- | id | path | string | yes | Resource identifier |
73
-
74
- **Request Body**:
75
- ```json
76
- {
77
- "field": "type - description"
78
- }
79
- ```
80
-
81
- **Responses**:
82
- | Status | Description |
83
- |--------|-------------|
84
- | 200 | Success - {description} |
85
- | 400 | Bad Request - {when} |
86
- | 401 | Unauthorized - {when} |
87
- | 404 | Not Found - {when} |
88
-
89
- **Example**:
90
- ```bash
91
- curl -X {METHOD} /api/{path} \
92
- -H "Authorization: Bearer {token}" \
93
- -d '{"field": "value"}'
94
- ```
95
-
96
- ### Missing Documentation
97
- - **[DOC-001]** Endpoint {METHOD} {path} has no description
98
- - **[DOC-002]** Error response {status} not documented for {endpoint}
99
- ```
1
+ # API Documenter
2
+
3
+ <!-- API Documentation Generation Agent -->
4
+
5
+ ## Role
6
+
7
+ - Analyze source code to extract API endpoints and interfaces
8
+ - Generate structured API documentation (request/response schemas)
9
+ - Identify undocumented endpoints and missing descriptions
10
+ - Verify error response documentation completeness
11
+ - Check authentication requirement documentation
12
+
13
+ ## Model
14
+
15
+ **Haiku** (inherit) - Fast analysis
16
+
17
+ ## CRITICAL: NO FILE CREATION
18
+
19
+ **THIS AGENT MUST NEVER CREATE FILES.**
20
+
21
+ - DO NOT use Write tool
22
+ - DO NOT create any files
23
+ - ONLY return documentation as text output
24
+ - Results can be used by other tools to generate files
25
+
26
+ ## Checklist
27
+
28
+ ### Endpoint Coverage
29
+
30
+ - [ ] All route handlers/controllers documented?
31
+ - [ ] HTTP method and path clearly specified?
32
+ - [ ] Request parameters (path, query, body) described?
33
+ - [ ] Response schemas for success and error cases?
34
+ - [ ] Authentication requirements noted?
35
+
36
+ ### Schema Quality
37
+
38
+ - [ ] All fields have types and descriptions?
39
+ - [ ] Required vs optional fields marked?
40
+ - [ ] Enum values listed?
41
+ - [ ] Nested objects described?
42
+ - [ ] Array item types specified?
43
+
44
+ ### Error Documentation
45
+
46
+ - [ ] All error status codes documented?
47
+ - [ ] Error response format specified?
48
+ - [ ] Common error scenarios listed?
49
+ - [ ] Rate limiting documented (if applicable)?
50
+
51
+ ### Examples
52
+
53
+ - [ ] Request examples for each endpoint?
54
+ - [ ] Response examples (success + error)?
55
+ - [ ] cURL or fetch examples?
56
+
57
+ ## Output Format
58
+
59
+ ```markdown
60
+ ## API Documentation: {feature/module name}
61
+
62
+ ### Endpoints Found: {N}
63
+ ### Undocumented: {N}
64
+
65
+ ### Endpoint: {METHOD} {path}
66
+
67
+ **Authentication**: {required/optional/none}
68
+
69
+ **Parameters**:
70
+ | Name | In | Type | Required | Description |
71
+ |------|----|------|----------|-------------|
72
+ | id | path | string | yes | Resource identifier |
73
+
74
+ **Request Body**:
75
+ ```json
76
+ {
77
+ "field": "type - description"
78
+ }
79
+ ```
80
+
81
+ **Responses**:
82
+ | Status | Description |
83
+ |--------|-------------|
84
+ | 200 | Success - {description} |
85
+ | 400 | Bad Request - {when} |
86
+ | 401 | Unauthorized - {when} |
87
+ | 404 | Not Found - {when} |
88
+
89
+ **Example**:
90
+ ```bash
91
+ curl -X {METHOD} /api/{path} \
92
+ -H "Authorization: Bearer {token}" \
93
+ -d '{"field": "value"}'
94
+ ```
95
+
96
+ ### Missing Documentation
97
+ - **[DOC-001]** Endpoint {METHOD} {path} has no description
98
+ - **[DOC-002]** Error response {status} not documented for {endpoint}
99
+ ```