@relipa/ai-flow-kit 0.0.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 (204) hide show
  1. package/AIFLOW.md +432 -0
  2. package/CHANGELOG.md +78 -0
  3. package/CONTRIBUTING.md +351 -0
  4. package/IMPLEMENTATION_SUMMARY.md +348 -0
  5. package/QUICK_START.md +392 -0
  6. package/README.md +323 -0
  7. package/bin/aiflow.js +178 -0
  8. package/custom/mcp-presets/README.md +138 -0
  9. package/custom/mcp-presets/backlog.json +15 -0
  10. package/custom/mcp-presets/figma.json +15 -0
  11. package/custom/mcp-presets/google-sheets.json +14 -0
  12. package/custom/mcp-presets/jira.json +16 -0
  13. package/custom/prompts/bug-fix.md +149 -0
  14. package/custom/prompts/feature.md +190 -0
  15. package/custom/prompts/investigation.md +164 -0
  16. package/custom/rules/code-style.md +7 -0
  17. package/custom/rules/java/code-style.md +11 -0
  18. package/custom/rules/java/naming.md +17 -0
  19. package/custom/rules/java/review-checklist.md +36 -0
  20. package/custom/rules/javascript/code-style.md +12 -0
  21. package/custom/rules/javascript/naming.md +14 -0
  22. package/custom/rules/naming.md +9 -0
  23. package/custom/rules/php/code-style.md +10 -0
  24. package/custom/rules/php/naming.md +15 -0
  25. package/custom/rules/review-checklist.md +9 -0
  26. package/custom/skills/figma-to-component/SKILL.md +207 -0
  27. package/custom/skills/generate-spec/SKILL.md +97 -0
  28. package/custom/skills/impact-analysis/SKILL.md +94 -0
  29. package/custom/skills/investigate-bug/SKILL.md +93 -0
  30. package/custom/skills/report-customer/SKILL.md +95 -0
  31. package/custom/skills/review-plan/SKILL.md +158 -0
  32. package/custom/skills/validate-ticket/SKILL.md +240 -0
  33. package/custom/templates/laravel.md +90 -0
  34. package/custom/templates/nextjs.md +89 -0
  35. package/custom/templates/reactjs.md +567 -0
  36. package/custom/templates/spring-boot.md +598 -0
  37. package/custom/templates/vue-nuxt.md +89 -0
  38. package/docs/architecture.md +395 -0
  39. package/docs/cli-reference.md +438 -0
  40. package/docs/configuration.md +412 -0
  41. package/docs/getting-started.md +248 -0
  42. package/docs/troubleshooting.md +587 -0
  43. package/docs/workflows/bug-fix.md +126 -0
  44. package/docs/workflows/feature.md +123 -0
  45. package/docs/workflows/impact-analysis.md +13 -0
  46. package/docs/workflows/investigation.md +13 -0
  47. package/docs/workflows/refactor.md +13 -0
  48. package/index.js +27 -0
  49. package/package.json +70 -0
  50. package/scripts/config.js +317 -0
  51. package/scripts/context.js +117 -0
  52. package/scripts/detect.js +239 -0
  53. package/scripts/doctor.js +48 -0
  54. package/scripts/guide.js +282 -0
  55. package/scripts/hooks/session-start.js +140 -0
  56. package/scripts/init.js +453 -0
  57. package/scripts/memory.js +247 -0
  58. package/scripts/prompt.js +392 -0
  59. package/scripts/remove.js +170 -0
  60. package/scripts/update.js +111 -0
  61. package/scripts/use.js +570 -0
  62. package/scripts/validate.js +303 -0
  63. package/upstream/.claude-plugin/marketplace.json +20 -0
  64. package/upstream/.claude-plugin/plugin.json +20 -0
  65. package/upstream/.codex/INSTALL.md +67 -0
  66. package/upstream/.cursor-plugin/plugin.json +25 -0
  67. package/upstream/.gitattributes +18 -0
  68. package/upstream/.github/FUNDING.yml +3 -0
  69. package/upstream/.github/ISSUE_TEMPLATE/bug_report.md +52 -0
  70. package/upstream/.github/ISSUE_TEMPLATE/config.yml +5 -0
  71. package/upstream/.github/ISSUE_TEMPLATE/feature_request.md +34 -0
  72. package/upstream/.github/ISSUE_TEMPLATE/platform_support.md +23 -0
  73. package/upstream/.github/PULL_REQUEST_TEMPLATE.md +87 -0
  74. package/upstream/.opencode/INSTALL.md +83 -0
  75. package/upstream/.opencode/plugins/superpowers.js +112 -0
  76. package/upstream/.version-bump.json +19 -0
  77. package/upstream/AGENTS.md +1 -0
  78. package/upstream/CHANGELOG.md +13 -0
  79. package/upstream/CLAUDE.md +85 -0
  80. package/upstream/CODE_OF_CONDUCT.md +128 -0
  81. package/upstream/GEMINI.md +2 -0
  82. package/upstream/LICENSE +21 -0
  83. package/upstream/README.md +190 -0
  84. package/upstream/RELEASE-NOTES.md +1096 -0
  85. package/upstream/agents/code-reviewer.md +48 -0
  86. package/upstream/commands/brainstorm.md +5 -0
  87. package/upstream/commands/execute-plan.md +5 -0
  88. package/upstream/commands/write-plan.md +5 -0
  89. package/upstream/docs/README.codex.md +126 -0
  90. package/upstream/docs/README.opencode.md +130 -0
  91. package/upstream/docs/plans/2025-11-22-opencode-support-design.md +294 -0
  92. package/upstream/docs/plans/2025-11-22-opencode-support-implementation.md +1095 -0
  93. package/upstream/docs/plans/2025-11-28-skills-improvements-from-user-feedback.md +711 -0
  94. package/upstream/docs/plans/2026-01-17-visual-brainstorming.md +571 -0
  95. package/upstream/docs/superpowers/plans/2026-01-22-document-review-system.md +301 -0
  96. package/upstream/docs/superpowers/plans/2026-02-19-visual-brainstorming-refactor.md +523 -0
  97. package/upstream/docs/superpowers/plans/2026-03-11-zero-dep-brainstorm-server.md +479 -0
  98. package/upstream/docs/superpowers/plans/2026-03-23-codex-app-compatibility.md +564 -0
  99. package/upstream/docs/superpowers/specs/2026-01-22-document-review-system-design.md +136 -0
  100. package/upstream/docs/superpowers/specs/2026-02-19-visual-brainstorming-refactor-design.md +162 -0
  101. package/upstream/docs/superpowers/specs/2026-03-11-zero-dep-brainstorm-server-design.md +118 -0
  102. package/upstream/docs/superpowers/specs/2026-03-23-codex-app-compatibility-design.md +244 -0
  103. package/upstream/docs/testing.md +303 -0
  104. package/upstream/docs/windows/polyglot-hooks.md +212 -0
  105. package/upstream/gemini-extension.json +6 -0
  106. package/upstream/hooks/hooks-cursor.json +10 -0
  107. package/upstream/hooks/hooks.json +16 -0
  108. package/upstream/hooks/run-hook.cmd +46 -0
  109. package/upstream/hooks/session-start +57 -0
  110. package/upstream/package.json +6 -0
  111. package/upstream/scripts/bump-version.sh +220 -0
  112. package/upstream/skills/brainstorming/SKILL.md +164 -0
  113. package/upstream/skills/brainstorming/scripts/frame-template.html +214 -0
  114. package/upstream/skills/brainstorming/scripts/helper.js +88 -0
  115. package/upstream/skills/brainstorming/scripts/server.cjs +354 -0
  116. package/upstream/skills/brainstorming/scripts/start-server.sh +148 -0
  117. package/upstream/skills/brainstorming/scripts/stop-server.sh +56 -0
  118. package/upstream/skills/brainstorming/spec-document-reviewer-prompt.md +49 -0
  119. package/upstream/skills/brainstorming/visual-companion.md +287 -0
  120. package/upstream/skills/dispatching-parallel-agents/SKILL.md +182 -0
  121. package/upstream/skills/executing-plans/SKILL.md +70 -0
  122. package/upstream/skills/finishing-a-development-branch/SKILL.md +200 -0
  123. package/upstream/skills/receiving-code-review/SKILL.md +213 -0
  124. package/upstream/skills/requesting-code-review/SKILL.md +105 -0
  125. package/upstream/skills/requesting-code-review/code-reviewer.md +146 -0
  126. package/upstream/skills/subagent-driven-development/SKILL.md +277 -0
  127. package/upstream/skills/subagent-driven-development/code-quality-reviewer-prompt.md +26 -0
  128. package/upstream/skills/subagent-driven-development/implementer-prompt.md +113 -0
  129. package/upstream/skills/subagent-driven-development/spec-reviewer-prompt.md +61 -0
  130. package/upstream/skills/systematic-debugging/CREATION-LOG.md +119 -0
  131. package/upstream/skills/systematic-debugging/SKILL.md +296 -0
  132. package/upstream/skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
  133. package/upstream/skills/systematic-debugging/condition-based-waiting.md +115 -0
  134. package/upstream/skills/systematic-debugging/defense-in-depth.md +122 -0
  135. package/upstream/skills/systematic-debugging/find-polluter.sh +63 -0
  136. package/upstream/skills/systematic-debugging/root-cause-tracing.md +169 -0
  137. package/upstream/skills/systematic-debugging/test-academic.md +14 -0
  138. package/upstream/skills/systematic-debugging/test-pressure-1.md +58 -0
  139. package/upstream/skills/systematic-debugging/test-pressure-2.md +68 -0
  140. package/upstream/skills/systematic-debugging/test-pressure-3.md +69 -0
  141. package/upstream/skills/test-driven-development/SKILL.md +371 -0
  142. package/upstream/skills/test-driven-development/testing-anti-patterns.md +299 -0
  143. package/upstream/skills/using-git-worktrees/SKILL.md +218 -0
  144. package/upstream/skills/using-superpowers/SKILL.md +117 -0
  145. package/upstream/skills/using-superpowers/references/codex-tools.md +100 -0
  146. package/upstream/skills/using-superpowers/references/copilot-tools.md +52 -0
  147. package/upstream/skills/using-superpowers/references/gemini-tools.md +33 -0
  148. package/upstream/skills/verification-before-completion/SKILL.md +139 -0
  149. package/upstream/skills/writing-plans/SKILL.md +152 -0
  150. package/upstream/skills/writing-plans/plan-document-reviewer-prompt.md +49 -0
  151. package/upstream/skills/writing-skills/SKILL.md +655 -0
  152. package/upstream/skills/writing-skills/anthropic-best-practices.md +1150 -0
  153. package/upstream/skills/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -0
  154. package/upstream/skills/writing-skills/graphviz-conventions.dot +172 -0
  155. package/upstream/skills/writing-skills/persuasion-principles.md +187 -0
  156. package/upstream/skills/writing-skills/render-graphs.js +168 -0
  157. package/upstream/skills/writing-skills/testing-skills-with-subagents.md +384 -0
  158. package/upstream/tests/brainstorm-server/package-lock.json +36 -0
  159. package/upstream/tests/brainstorm-server/package.json +10 -0
  160. package/upstream/tests/brainstorm-server/server.test.js +427 -0
  161. package/upstream/tests/brainstorm-server/windows-lifecycle.test.sh +351 -0
  162. package/upstream/tests/brainstorm-server/ws-protocol.test.js +392 -0
  163. package/upstream/tests/claude-code/README.md +158 -0
  164. package/upstream/tests/claude-code/analyze-token-usage.py +168 -0
  165. package/upstream/tests/claude-code/run-skill-tests.sh +187 -0
  166. package/upstream/tests/claude-code/test-document-review-system.sh +177 -0
  167. package/upstream/tests/claude-code/test-helpers.sh +202 -0
  168. package/upstream/tests/claude-code/test-subagent-driven-development-integration.sh +314 -0
  169. package/upstream/tests/claude-code/test-subagent-driven-development.sh +165 -0
  170. package/upstream/tests/explicit-skill-requests/prompts/action-oriented.txt +3 -0
  171. package/upstream/tests/explicit-skill-requests/prompts/after-planning-flow.txt +17 -0
  172. package/upstream/tests/explicit-skill-requests/prompts/claude-suggested-it.txt +11 -0
  173. package/upstream/tests/explicit-skill-requests/prompts/i-know-what-sdd-means.txt +8 -0
  174. package/upstream/tests/explicit-skill-requests/prompts/mid-conversation-execute-plan.txt +3 -0
  175. package/upstream/tests/explicit-skill-requests/prompts/please-use-brainstorming.txt +1 -0
  176. package/upstream/tests/explicit-skill-requests/prompts/skip-formalities.txt +3 -0
  177. package/upstream/tests/explicit-skill-requests/prompts/subagent-driven-development-please.txt +1 -0
  178. package/upstream/tests/explicit-skill-requests/prompts/use-systematic-debugging.txt +1 -0
  179. package/upstream/tests/explicit-skill-requests/run-all.sh +70 -0
  180. package/upstream/tests/explicit-skill-requests/run-claude-describes-sdd.sh +100 -0
  181. package/upstream/tests/explicit-skill-requests/run-extended-multiturn-test.sh +113 -0
  182. package/upstream/tests/explicit-skill-requests/run-haiku-test.sh +144 -0
  183. package/upstream/tests/explicit-skill-requests/run-multiturn-test.sh +143 -0
  184. package/upstream/tests/explicit-skill-requests/run-test.sh +136 -0
  185. package/upstream/tests/opencode/run-tests.sh +163 -0
  186. package/upstream/tests/opencode/setup.sh +88 -0
  187. package/upstream/tests/opencode/test-plugin-loading.sh +82 -0
  188. package/upstream/tests/opencode/test-priority.sh +198 -0
  189. package/upstream/tests/opencode/test-tools.sh +104 -0
  190. package/upstream/tests/skill-triggering/prompts/dispatching-parallel-agents.txt +8 -0
  191. package/upstream/tests/skill-triggering/prompts/executing-plans.txt +1 -0
  192. package/upstream/tests/skill-triggering/prompts/requesting-code-review.txt +3 -0
  193. package/upstream/tests/skill-triggering/prompts/systematic-debugging.txt +11 -0
  194. package/upstream/tests/skill-triggering/prompts/test-driven-development.txt +7 -0
  195. package/upstream/tests/skill-triggering/prompts/writing-plans.txt +10 -0
  196. package/upstream/tests/skill-triggering/run-all.sh +60 -0
  197. package/upstream/tests/skill-triggering/run-test.sh +88 -0
  198. package/upstream/tests/subagent-driven-dev/go-fractals/design.md +81 -0
  199. package/upstream/tests/subagent-driven-dev/go-fractals/plan.md +172 -0
  200. package/upstream/tests/subagent-driven-dev/go-fractals/scaffold.sh +45 -0
  201. package/upstream/tests/subagent-driven-dev/run-test.sh +106 -0
  202. package/upstream/tests/subagent-driven-dev/svelte-todo/design.md +70 -0
  203. package/upstream/tests/subagent-driven-dev/svelte-todo/plan.md +222 -0
  204. package/upstream/tests/subagent-driven-dev/svelte-todo/scaffold.sh +46 -0
package/QUICK_START.md ADDED
@@ -0,0 +1,392 @@
1
+ # Quick Start — AI Flow Kit
2
+
3
+ > Full workflow: [AIFLOW.md](./AIFLOW.md) | Contributing: [CONTRIBUTING.md](./CONTRIBUTING.md)
4
+
5
+ ---
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install -g ai-flow-kit
11
+ aiflow --version
12
+ ```
13
+
14
+ ---
15
+
16
+ ## Project Setup (One-time)
17
+
18
+ ```bash
19
+ cd your-project
20
+
21
+ # Single framework + adapter
22
+ aiflow init --framework spring-boot --adapter backlog
23
+
24
+ # Or multiple
25
+ aiflow init --framework spring-boot,reactjs --adapter backlog,jira
26
+ ```
27
+
28
+ During init:
29
+ - Enter `BACKLOG_API_KEY` and `BACKLOG_SPACE_KEY` when prompted
30
+ - Press Enter to keep the old value (if previously set up)
31
+ - The package automatically verifies credentials right after input
32
+
33
+ Results after init:
34
+ ```
35
+ ✓ Superpowers skills ready (built-in)
36
+ ✓ Applied java rules
37
+ ✓ CLAUDE.md updated for framework: spring-boot
38
+ ✓ Credentials verified successfully
39
+ ✓ Superpowers SessionStart hook configured
40
+ ✨ Initialized AI Flow Kit successfully!
41
+ ```
42
+
43
+ Check setup:
44
+ ```bash
45
+ aiflow doctor
46
+ ```
47
+
48
+ ---
49
+
50
+ ## Complete Developer Workflow (Start → Finish)
51
+
52
+ > **5-Gate workflow: Gate must pass in order. No skipping.**
53
+ >
54
+ > See [AIFLOW.md](./AIFLOW.md) for full details on each gate.
55
+
56
+ ### Step 1: Load ticket context
57
+
58
+ ```bash
59
+ # Load from Backlog (description only)
60
+ aiflow use PROJ-33
61
+
62
+ # Load with comments (recommended for bug-fix)
63
+ aiflow use PROJ-33 --with-comments
64
+
65
+ # Load from Backlog URL
66
+ aiflow use https://mycompany.backlog.com/view/PROJ-33
67
+
68
+ # Load newest 5 comments
69
+ aiflow use PROJ-33 --comments-last 5
70
+
71
+ # Manual input (no Backlog/Jira)
72
+ aiflow use --manual
73
+ ```
74
+
75
+ Output:
76
+ ```
77
+ ✓ Context loaded
78
+
79
+ Ticket: PROJ-33
80
+ Type: bug-fix
81
+ Title: [ticket title]
82
+ Status: In Progress
83
+ Assignee: yourname
84
+ ```
85
+
86
+ ### Step 2: Open Claude — AI auto-starts
87
+
88
+ ```bash
89
+ claude # AI auto-starts Gate 1 immediately
90
+ ```
91
+
92
+ > **Note:** `aiflow prompt` is optional — only needed when pasting into Claude Desktop/Web.
93
+ > In Claude Code CLI, the SessionStart hook auto-injects ticket context and triggers Gate 1.
94
+
95
+ ### Step 3: GATE 1 — AI Analyzes Requirement
96
+
97
+ **What happens:** AI reads your ticket + source code + asks questions.
98
+
99
+ When you open Claude, AI will **automatically** start analyzing:
100
+
101
+ 1. **Read ticket** from `.claude/context/current.json`
102
+ 2. **Read source code** — understand architecture, related files, data flow
103
+ 3. **Ask clarifying questions** (one at a time) if anything is unclear
104
+ 4. **Output** `plan/PROJ-33/requirement.md` containing:
105
+ - Requirements summary (AI's technical understanding)
106
+ - Source code analysis (related files, data flow, patterns)
107
+ - **Proposed solution** with recommendation
108
+ - **Impact analysis** — what areas are affected, risks
109
+ - **Effort estimate** (S/M/L/XL)
110
+ - Testing plan
111
+
112
+ **Your action:** Review the requirement document.
113
+
114
+ ```
115
+ # If satisfied:
116
+ APPROVED
117
+
118
+ # If something needs to change:
119
+ "The solution should use Redis cache instead of in-memory"
120
+ → AI updates the document and asks again
121
+ ```
122
+
123
+ ### Step 4: GATE 2 — Review Implementation Plan
124
+
125
+ **What happens:** AI creates a detailed coding plan based on the approved requirement.
126
+
127
+ AI outputs:
128
+ - TDD task breakdown (test first → implement → verify)
129
+ - Commit strategy (small, focused commits)
130
+ - Test commands
131
+
132
+ **Your action:**
133
+
134
+ ```
135
+ # If the plan looks good:
136
+ APPROVED
137
+
138
+ # If you want changes:
139
+ "Split task 3 into smaller steps"
140
+ → AI adjusts the plan
141
+ ```
142
+
143
+ ### Step 5: GATE 3 — AI Generates Code (TDD)
144
+
145
+ **What happens:** AI writes code following the approved plan.
146
+
147
+ - Writes tests FIRST → runs → confirms FAIL
148
+ - Implements code → tests PASS
149
+ - Commits each small step
150
+
151
+ **Your action:** Monitor. No action needed unless AI asks a question.
152
+
153
+ ### Step 6: GATE 4 — Review AI's Work
154
+
155
+ **What happens:** AI self-reviews before showing you.
156
+
157
+ AI runs automatically:
158
+ 1. `verification-before-completion` — all tests PASS
159
+ 2. `impact-analysis` — no breaking changes
160
+ 3. Review checklist — all items checked
161
+ 4. Creates `plan/PROJ-33/summary.md`
162
+
163
+ Then shows you:
164
+ ```
165
+ ⏸️ GATE 4: WAITING FOR DEV REVIEW
166
+
167
+ Tests: ✅ 12 passed
168
+ Impact: 🟢 Low
169
+ Checklist: 7/7 ✅
170
+ Summary: plan/PROJ-33/summary.md
171
+ ```
172
+
173
+ **Your action:**
174
+
175
+ ```
176
+ # If everything is OK:
177
+ APPROVED
178
+
179
+ # If there's a bug in the code:
180
+ BUG: The cache invalidation doesn't handle concurrent writes
181
+
182
+ # If the requirement was wrong:
183
+ BUG: Actually we need to support pagination, not just single page
184
+ → AI goes back to Gate 1 to update requirement
185
+ ```
186
+
187
+ ### Step 7: GATE 5 — Create PR & Peer Review
188
+
189
+ **What happens:** AI helps create the Pull Request.
190
+
191
+ ```bash
192
+ git push origin feature/PROJ-33-description
193
+ # AI suggests PR title, description, and checklist
194
+ ```
195
+
196
+ Ask a teammate to review. They can use `superpowers:receiving-code-review` skill.
197
+
198
+ ### Step 8: Done!
199
+
200
+ After peer reviewer approves → merge → task complete.
201
+
202
+ ---
203
+
204
+ ## Workflow Summary Diagram
205
+
206
+ ```
207
+ Developer AI Peer
208
+ │ │ │
209
+ │ aiflow use PROJ-33 │ │
210
+ │ claude │ │
211
+ │ │ │
212
+ │ ─── GATE 1 ──────────────────►│ │
213
+ │ │ Read ticket + source code │
214
+ │ │ Ask questions (1 at a time) │
215
+ │ ◄─── requirement.md ─────────│ │
216
+ │ │ │
217
+ │ "APPROVED" ──────────────────►│ │
218
+ │ │ │
219
+ │ ─── GATE 2 ──────────────────►│ │
220
+ │ │ Create implementation plan │
221
+ │ ◄─── plan ───────────────────│ │
222
+ │ │ │
223
+ │ "APPROVED" ──────────────────►│ │
224
+ │ │ │
225
+ │ GATE 3 │ Write tests → implement │
226
+ │ (monitor) │ Commit each step │
227
+ │ │ │
228
+ │ ─── GATE 4 ──────────────────►│ │
229
+ │ │ Self-review + summary │
230
+ │ ◄─── summary.md ────────────│ │
231
+ │ │ │
232
+ │ "APPROVED" ──────────────────►│ │
233
+ │ │ │
234
+ │ ─── GATE 5 ─────────────────────────────────────────────────►│
235
+ │ │ Review PR
236
+ │ ◄──────────────────────────────────────────── APPROVED ──────│
237
+ │ │ │
238
+ │ Merge ✅ │ │
239
+ ```
240
+
241
+ ---
242
+
243
+ ## Use Cases
244
+
245
+ ### Bug Fix
246
+
247
+ ```bash
248
+ aiflow use PROJ-33 --with-comments
249
+ claude # AI auto-starts: analyze bug → trace root cause → propose fix
250
+ ```
251
+
252
+ ### New Feature
253
+
254
+ ```bash
255
+ aiflow use PROJ-99
256
+ claude # AI auto-starts: analyze requirements → propose architecture
257
+ ```
258
+
259
+ ### Investigation (no coding)
260
+
261
+ ```bash
262
+ aiflow use PROJ-50
263
+ claude # AI auto-starts: investigate → output findings report
264
+ ```
265
+
266
+ ### Refactoring
267
+
268
+ ```bash
269
+ aiflow use PROJ-77
270
+ claude # AI auto-starts: analyze impact → plan refactor steps
271
+ ```
272
+
273
+ ### Impact Analysis (no coding)
274
+
275
+ ```bash
276
+ aiflow use PROJ-88
277
+ claude # AI auto-starts: map dependencies → assess risk → output report
278
+ ```
279
+
280
+ ---
281
+
282
+ ## All Commands
283
+
284
+ ```bash
285
+ # Setup
286
+ aiflow init --framework spring-boot --adapter backlog
287
+ aiflow doctor # health check
288
+ aiflow update # update to latest version
289
+ aiflow update --force # force update (same version)
290
+
291
+ # Per task
292
+ aiflow use PROJ-33 # load ticket context
293
+ aiflow use PROJ-33 --with-comments # load with comments
294
+ aiflow use PROJ-33 --comments-last 5 # newest 5 comments
295
+ aiflow use --manual # manual input
296
+ aiflow prompt bug-fix # generate prompt
297
+ aiflow prompt feature --output p.md # save prompt to file
298
+ aiflow prompt --list # list all prompt types
299
+
300
+ # Context management
301
+ aiflow context show # view active context
302
+ aiflow context list # list saved contexts
303
+ aiflow context save my-snapshot # save named snapshot
304
+ aiflow context load my-snapshot # load named snapshot
305
+ aiflow context clear # clear active context
306
+
307
+ # Team knowledge
308
+ aiflow memory save "key" "value" # save knowledge
309
+ aiflow memory get "key" # retrieve
310
+ aiflow memory search "keyword" # search
311
+ aiflow memory list # list all
312
+
313
+ # Utilities
314
+ aiflow validate src/File.java # validate code
315
+ aiflow detect "description" # detect task type
316
+ aiflow guide # full quickstart guide
317
+ aiflow guide --flow # architecture diagram
318
+ aiflow guide --commands # command reference
319
+
320
+ # Maintenance
321
+ aiflow remove # remove from project
322
+ aiflow remove --global # uninstall globally
323
+ aiflow remove --version 1.0.0 # remove cached version
324
+ ```
325
+
326
+ ---
327
+
328
+ ## Documentation Files
329
+
330
+ After installing `ai-flow-kit`, these docs are available:
331
+
332
+ | File | Description |
333
+ |------|-------------|
334
+ | [QUICK_START.md](./QUICK_START.md) | This file — step-by-step guide for developers |
335
+ | [AIFLOW.md](./AIFLOW.md) | Complete 5-Gate workflow: who does what, outputs, templates |
336
+ | [README.md](./README.md) | Package overview, architecture, all features |
337
+ | [CONTRIBUTING.md](./CONTRIBUTING.md) | How to add skills, templates, adapters, rules |
338
+ | [IMPLEMENTATION_SUMMARY.md](./IMPLEMENTATION_SUMMARY.md) | Technical implementation details |
339
+ | [docs/workflows/](./docs/workflows/) | Per-task-type workflow guides |
340
+ | [docs/architecture.md](./docs/architecture.md) | System architecture |
341
+ | [docs/cli-reference.md](./docs/cli-reference.md) | CLI command reference |
342
+ | [docs/configuration.md](./docs/configuration.md) | Configuration guide |
343
+ | [docs/troubleshooting.md](./docs/troubleshooting.md) | Common issues & fixes |
344
+ | [docs/getting-started.md](./docs/getting-started.md) | Getting started guide |
345
+
346
+ Access docs after install:
347
+ ```bash
348
+ # Docs are in the package directory
349
+ npm root -g # find global packages directory
350
+ # → <path>/ai-flow-kit/AIFLOW.md, QUICK_START.md, etc.
351
+
352
+ # Or use the built-in guide
353
+ aiflow guide
354
+ ```
355
+
356
+ ---
357
+
358
+ ## Troubleshooting
359
+
360
+ **`aiflow` not found:**
361
+ ```bash
362
+ npm install -g ai-flow-kit
363
+ ```
364
+
365
+ **Incorrect credentials:**
366
+ ```bash
367
+ # Re-running will prompt again; press Enter to keep the old value
368
+ aiflow init --adapter backlog
369
+ ```
370
+
371
+ **Context not loading:**
372
+ ```bash
373
+ # Check if credentials are saved
374
+ cat .aiflow/credentials.json
375
+
376
+ # Try loading again
377
+ aiflow use PROJ-33
378
+ ```
379
+
380
+ **Skills not working in Claude:**
381
+ ```bash
382
+ # init must be run outside the Claude terminal (once)
383
+ # Then reopen Claude
384
+ aiflow doctor
385
+ ```
386
+
387
+ **Need to see all available prompt types:**
388
+ ```bash
389
+ aiflow prompt --list
390
+ ```
391
+
392
+ See more: [docs/troubleshooting.md](./docs/troubleshooting.md)
package/README.md ADDED
@@ -0,0 +1,323 @@
1
+ # AI Flow Kit
2
+
3
+ **All-in-one package for software development teams using Claude AI.**
4
+
5
+ Developers only need a single command to load ticket context → AI automatically understands the requirements, chooses the workflow, and follows team rules — no long prompts needed, no need to know the templates.
6
+
7
+ ---
8
+
9
+ ## Problems Solved
10
+
11
+ | Problem | Solution |
12
+ |--------|-----------|
13
+ | Multi-step, complex installation | `aiflow init` — 1 command to set up everything |
14
+ | Need long prompts for AI to understand | `aiflow use PROJ-33` — AI automatically reads from ticket |
15
+ | Too many templates, not sure which to use | AI auto-detects task type and selects the appropriate skill |
16
+ | New plugins (superpowers, MCP...) require manual setup | Package auto-sets up hooks, skills, and MCP on init |
17
+ | Missing investigation / bug reproduction flow | Skill `investigate-bug` (inherits systematic-debugging) |
18
+ | Missing impact analysis flow | Skill `impact-analysis` |
19
+
20
+ ---
21
+
22
+ ## Overview Flow
23
+
24
+ ```
25
+ ┌─────────────────────────────────────────────────────────────────┐
26
+ │ TECH LEAD │
27
+ │ npm publish ai-flow-kit → developer: npm install -g │
28
+ └─────────────────────────────────┬───────────────────────────────┘
29
+
30
+ ┌─────────────▼─────────────┐
31
+ │ aiflow init │
32
+ │ --framework spring-boot │
33
+ │ --adapter backlog │
34
+ └─────────────┬─────────────┘
35
+ │ setup
36
+ ┌─────────────▼──────────────────────────────┐
37
+ │ Project │
38
+ │ .claude/ │
39
+ │ ├── skills/ ← superpowers + custom│
40
+ │ ├── hooks/ ← SessionStart hook │
41
+ │ ├── settings.json ← hook config │
42
+ │ └── context/ ← ticket context │
43
+ │ .rules/ ← team rules (java/) │
44
+ │ CLAUDE.md ← framework template │
45
+ │ .mcp.json ← MCP adapter config │
46
+ └─────────────┬──────────────────────────────┘
47
+
48
+ ┌──────────────────▼──────────────────┐
49
+ │ Developer workflow │
50
+ │ │
51
+ │ 1. aiflow use PROJ-33 │
52
+ │ └─ Pull title, description, │
53
+ │ and comments from Backlog │
54
+ │ └─ Save → .claude/context/ │
55
+ │ │
56
+ │ 2. claude (open Claude terminal) │
57
+ │ │
58
+ │ 3. "Fix bug PROJ-33" (1 line) │
59
+ └──────────────────┬──────────────────┘
60
+
61
+ ┌──────────────────▼──────────────────┐
62
+ │ Claude AI │
63
+ │ │
64
+ │ SessionStart hook injected │
65
+ │ using-superpowers skill │
66
+ │ ↓ │
67
+ │ Read CLAUDE.md (spring-boot rules) │
68
+ │ ↓ │
69
+ │ Read context/current.json (PROJ-33) │
70
+ │ ↓ │
71
+ │ Auto-detect: bug-fix task │
72
+ │ ↓ │
73
+ │ Invoke investigate-bug skill │
74
+ │ → inherits systematic-debugging │
75
+ │ → trace Controller→Service→Repo │
76
+ │ → git blame to understand history │
77
+ │ → propose minimal fix │
78
+ │ ↓ │
79
+ │ Invoke impact-analysis skill │
80
+ │ → check breaking changes │
81
+ └──────────────────┬──────────────────┘
82
+
83
+ ┌──────────────────▼──────────────────┐
84
+ │ Developer review │
85
+ │ git diff → test → commit │
86
+ └──────────────────────────────────────┘
87
+ ```
88
+
89
+ ---
90
+
91
+ ## Installation
92
+
93
+ ```bash
94
+ npm install -g ai-flow-kit
95
+ ```
96
+
97
+ ---
98
+
99
+ ## Commands
100
+
101
+ ### `aiflow init`
102
+
103
+ Initial setup for the project. Run once per project.
104
+
105
+ ```bash
106
+ # Single framework + adapter
107
+ aiflow init --framework spring-boot --adapter backlog
108
+
109
+ # Multiple frameworks and adapters
110
+ aiflow init --framework spring-boot,reactjs --adapter backlog,jira
111
+ ```
112
+
113
+ **What gets automatically set up:**
114
+ - `.claude/skills/` — superpowers skills + team custom skills
115
+ - `.claude/hooks/session-start.js` — SessionStart hook
116
+ - `.claude/settings.json` — hook configuration
117
+ - `.rules/` — team coding rules (based on framework language)
118
+ - `CLAUDE.md` — framework-specific AI prompt
119
+ - `.mcp.json` + Claude Desktop config — MCP adapter
120
+ - `.aiflow/credentials.json` — save API credentials
121
+
122
+ **Supported Frameworks:** `spring-boot`, `laravel`, `reactjs`, `nextjs`, `vue-nuxt`
123
+
124
+ **Supported Adapters:** `backlog`, `jira`, `google-sheets`, `figma`
125
+
126
+ ---
127
+
128
+ ### `aiflow use <ticket>`
129
+
130
+ Load ticket context into `.claude/context/current.json`.
131
+
132
+ ```bash
133
+ # Backlog
134
+ aiflow use PROJ-33
135
+ aiflow use https://mycompany.backlog.com/view/PROJ-33
136
+
137
+ # Jira
138
+ aiflow use PROJ-123
139
+
140
+ # Default: only load description
141
+ aiflow use PROJ-33
142
+
143
+ # Load with all comments
144
+ aiflow use PROJ-33 --with-comments
145
+
146
+ # Load newest 5 comments
147
+ aiflow use PROJ-33 --comments-last 5
148
+
149
+ # Load comments from index 3 onwards
150
+ aiflow use PROJ-33 --comments-from 3
151
+
152
+ # Manual input
153
+ aiflow use --manual
154
+
155
+ # Save with custom name
156
+ aiflow use PROJ-33 --save sprint-42-bug
157
+ ```
158
+
159
+ ---
160
+
161
+ ### `aiflow doctor`
162
+
163
+ Check if the setup is complete.
164
+
165
+ ```bash
166
+ aiflow doctor
167
+ ```
168
+
169
+ ```
170
+ ✓ .claude/skills exists (42 skills)
171
+ ✓ .rules exists
172
+ ✓ CLAUDE.md exists
173
+ ✓ SessionStart hook configured
174
+ ✓ Version tracking active (v1.0.0)
175
+ ✨ Everything looks healthy!
176
+ ```
177
+
178
+ ---
179
+
180
+ ### `aiflow update`
181
+
182
+ Update skills, rules, and templates to the latest version.
183
+
184
+ ```bash
185
+ aiflow update
186
+ ```
187
+
188
+ ---
189
+
190
+ ### `aiflow validate <file>`
191
+
192
+ Validate code output against team rules.
193
+
194
+ ```bash
195
+ aiflow validate src/Payment.java --ruleset strict
196
+ ```
197
+
198
+ ---
199
+
200
+ ### `aiflow memory`
201
+
202
+ Save/search team knowledge.
203
+
204
+ ```bash
205
+ aiflow memory --save "payment-flow" "Payment flow description..."
206
+ aiflow memory --search "payment"
207
+ aiflow memory --list
208
+ ```
209
+
210
+ ---
211
+
212
+ ## Available Skills
213
+
214
+ ### Custom skills (team-specific)
215
+
216
+ | Skill | Trigger | Description |
217
+ |-------|---------|-------|
218
+ | `investigate-bug` | "fix bug", "error", "crash" | Investigate bugs via data flow, inherits `systematic-debugging` |
219
+ | `impact-analysis` | "impact scope", "breaking change" | Analyze the impact when changing code |
220
+ | `generate-spec` | "new feature", "spec", "design" | Write technical specs, integrates `brainstorming` |
221
+ | `report-customer` | "customer report", "incident" | Write incident reports for Customer Service |
222
+ | `figma-to-component` | "figma", "design", "generate component" | Read Figma design → generate React/Next.js/Vue component |
223
+
224
+ ### Superpowers skills (upstream, inherited from obra/superpowers)
225
+
226
+ | Skill | Description |
227
+ |-------|-------|
228
+ | `systematic-debugging` | Core debugging methodology — NO FIX WITHOUT ROOT CAUSE |
229
+ | `brainstorming` | Explore requirements before coding |
230
+ | `writing-plans` | Create bite-sized implementation plans |
231
+ | `executing-plans` | Execute plans with review checkpoints |
232
+ | `test-driven-development` | RED→GREEN→REFACTOR |
233
+ | `subagent-driven-development` | Dispatch subagents for independent tasks |
234
+ | `requesting-code-review` | Review code before merging |
235
+ | `verification-before-completion` | Verify before claiming done |
236
+ | `using-git-worktrees` | Isolated workspace for feature work |
237
+ | `finishing-a-development-branch` | Complete branch and merge options |
238
+
239
+ ---
240
+
241
+ ## Framework Templates
242
+
243
+ | Framework | Language | Rules applied |
244
+ |-----------|---------|--------------|
245
+ | `spring-boot` | Java 17+ | `rules/java/` |
246
+ | `laravel` | PHP 8.1+ | `rules/php/` |
247
+ | `reactjs` | TypeScript | `rules/javascript/` |
248
+ | `nextjs` | TypeScript | `rules/javascript/` |
249
+ | `vue-nuxt` | TypeScript | `rules/javascript/` |
250
+
251
+ ---
252
+
253
+ ## Project Structure
254
+
255
+ ```
256
+ ai-flow-kit/
257
+ ├── bin/aiflow.js # CLI entry
258
+ ├── scripts/
259
+ │ ├── init.js # Project initialization
260
+ │ ├── update.js # Version management
261
+ │ ├── doctor.js # Health check
262
+ │ ├── use.js # Context loading (Backlog/Jira)
263
+ │ ├── config.js # Config system
264
+ │ ├── detect.js # Task type detection
265
+ │ ├── validate.js # Code validation
266
+ │ ├── memory.js # Knowledge management
267
+ │ └── hooks/session-start.js # SessionStart hook (Node.js)
268
+ ├── custom/
269
+ │ ├── skills/ # Team-specific AI skills
270
+ │ ├── rules/java/ # Java/Spring Boot rules
271
+ │ ├── rules/php/ # PHP/Laravel rules
272
+ │ ├── rules/javascript/ # JS/TS rules
273
+ │ ├── templates/ # Framework CLAUDE.md templates
274
+ │ ├── prompts/ # Task prompt templates
275
+ │ └── mcp-presets/ # Backlog/Jira/Sheets config
276
+ └── upstream/ # obra/superpowers (inherited)
277
+ ```
278
+
279
+ ---
280
+
281
+ ## Adding new frameworks / adapters
282
+
283
+ **New Framework:** create `custom/templates/<name>.md` + `custom/rules/<lang>/`
284
+
285
+ **New Adapter:** create `custom/mcp-presets/<name>.json`
286
+
287
+ **Custom skill:** create `custom/skills/<name>/SKILL.md`
288
+
289
+ Then run `aiflow update` to apply.
290
+
291
+ ---
292
+
293
+ ## Usage Environments
294
+
295
+ | Environment | Experience | Notes |
296
+ |-----------|------------|---------|
297
+ | Claude Code CLI (`claude`) | ⭐⭐⭐⭐⭐ | Full auto — skills, hook, automatically loaded context |
298
+ | Claude Extension (VS Code) | ⭐⭐⭐ | `aiflow prompt <type>` → copy paste |
299
+ | Antigravity / Cursor | ⭐⭐⭐ | `aiflow prompt <type>` → copy paste |
300
+
301
+ ---
302
+
303
+ ## Troubleshooting
304
+
305
+ **`aiflow` not found:**
306
+ ```bash
307
+ npm install -g ai-flow-kit
308
+ ```
309
+
310
+ **Backlog load fails:**
311
+ ```bash
312
+ aiflow doctor
313
+ # Re-setup credentials
314
+ aiflow init --adapter backlog
315
+ ```
316
+
317
+ **Skills not loading in Claude:**
318
+ ```bash
319
+ # Ensure init was run outside Claude terminal (session-start hook needs restart)
320
+ aiflow doctor
321
+ ```
322
+
323
+ See more: [docs/troubleshooting.md](./docs/troubleshooting.md)