forge-workflow 0.0.4 → 0.0.5

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 (209) hide show
  1. package/.claude/commands/dev.md +340 -340
  2. package/.claude/commands/plan.md +521 -521
  3. package/.claude/commands/premerge.md +176 -176
  4. package/.claude/commands/research.md +42 -42
  5. package/.claude/commands/review.md +442 -442
  6. package/.claude/commands/rollback.md +721 -721
  7. package/.claude/commands/ship.md +164 -164
  8. package/.claude/commands/sonarcloud.md +152 -152
  9. package/.claude/commands/status.md +48 -48
  10. package/.claude/commands/validate.md +282 -282
  11. package/.claude/commands/verify.md +221 -221
  12. package/.claude/rules/greptile-review-process.md +285 -285
  13. package/.claude/rules/workflow.md +105 -105
  14. package/.claude/scripts/greptile-resolve.sh +526 -526
  15. package/.claude/scripts/load-env.sh +32 -32
  16. package/.cline/workflows/dev.md +337 -337
  17. package/.cline/workflows/plan.md +518 -518
  18. package/.cline/workflows/premerge.md +173 -173
  19. package/.cline/workflows/research.md +39 -39
  20. package/.cline/workflows/review.md +439 -439
  21. package/.cline/workflows/rollback.md +718 -718
  22. package/.cline/workflows/ship.md +161 -161
  23. package/.cline/workflows/sonarcloud.md +146 -146
  24. package/.cline/workflows/status.md +45 -45
  25. package/.cline/workflows/validate.md +279 -279
  26. package/.cline/workflows/verify.md +218 -218
  27. package/.codex/config.toml +11 -11
  28. package/.codex/skills/dev/SKILL.md +340 -340
  29. package/.codex/skills/plan/SKILL.md +521 -521
  30. package/.codex/skills/premerge/SKILL.md +176 -176
  31. package/.codex/skills/research/SKILL.md +42 -42
  32. package/.codex/skills/review/SKILL.md +442 -442
  33. package/.codex/skills/rollback/SKILL.md +721 -721
  34. package/.codex/skills/ship/SKILL.md +164 -164
  35. package/.codex/skills/sonarcloud/SKILL.md +149 -149
  36. package/.codex/skills/status/SKILL.md +48 -48
  37. package/.codex/skills/validate/SKILL.md +282 -282
  38. package/.codex/skills/verify/SKILL.md +221 -221
  39. package/.cursor/commands/dev.md +337 -337
  40. package/.cursor/commands/plan.md +518 -518
  41. package/.cursor/commands/premerge.md +173 -173
  42. package/.cursor/commands/research.md +39 -39
  43. package/.cursor/commands/review.md +439 -439
  44. package/.cursor/commands/rollback.md +718 -718
  45. package/.cursor/commands/ship.md +161 -161
  46. package/.cursor/commands/sonarcloud.md +146 -146
  47. package/.cursor/commands/status.md +45 -45
  48. package/.cursor/commands/validate.md +279 -279
  49. package/.cursor/commands/verify.md +218 -218
  50. package/.cursor/rules/permissions-guidance.mdc +37 -37
  51. package/.forge/hooks/check-tdd.js +240 -240
  52. package/.github/PLUGIN_TEMPLATE.json +32 -32
  53. package/.github/prompts/dev.prompt.md +342 -342
  54. package/.github/prompts/plan.prompt.md +523 -523
  55. package/.github/prompts/premerge.prompt.md +178 -178
  56. package/.github/prompts/research.prompt.md +44 -44
  57. package/.github/prompts/review.prompt.md +444 -444
  58. package/.github/prompts/rollback.prompt.md +723 -723
  59. package/.github/prompts/ship.prompt.md +166 -166
  60. package/.github/prompts/sonarcloud.prompt.md +151 -151
  61. package/.github/prompts/status.prompt.md +50 -50
  62. package/.github/prompts/validate.prompt.md +284 -284
  63. package/.github/prompts/verify.prompt.md +223 -223
  64. package/.github/workflows/beads-to-github.yml +56 -0
  65. package/.github/workflows/github-to-beads.yml +97 -0
  66. package/.kilocode/workflows/dev.md +341 -341
  67. package/.kilocode/workflows/plan.md +522 -522
  68. package/.kilocode/workflows/premerge.md +177 -177
  69. package/.kilocode/workflows/research.md +43 -43
  70. package/.kilocode/workflows/review.md +443 -443
  71. package/.kilocode/workflows/rollback.md +722 -722
  72. package/.kilocode/workflows/ship.md +165 -165
  73. package/.kilocode/workflows/sonarcloud.md +150 -150
  74. package/.kilocode/workflows/status.md +49 -49
  75. package/.kilocode/workflows/validate.md +283 -283
  76. package/.kilocode/workflows/verify.md +222 -222
  77. package/.mcp.json.example +12 -12
  78. package/.opencode/commands/dev.md +340 -340
  79. package/.opencode/commands/plan.md +521 -521
  80. package/.opencode/commands/premerge.md +176 -176
  81. package/.opencode/commands/research.md +42 -42
  82. package/.opencode/commands/review.md +442 -442
  83. package/.opencode/commands/rollback.md +721 -721
  84. package/.opencode/commands/ship.md +164 -164
  85. package/.opencode/commands/sonarcloud.md +149 -149
  86. package/.opencode/commands/status.md +48 -48
  87. package/.opencode/commands/validate.md +282 -282
  88. package/.opencode/commands/verify.md +221 -221
  89. package/.roo/commands/dev.md +341 -341
  90. package/.roo/commands/plan.md +522 -522
  91. package/.roo/commands/premerge.md +177 -177
  92. package/.roo/commands/research.md +43 -43
  93. package/.roo/commands/review.md +443 -443
  94. package/.roo/commands/rollback.md +722 -722
  95. package/.roo/commands/ship.md +165 -165
  96. package/.roo/commands/sonarcloud.md +150 -150
  97. package/.roo/commands/status.md +49 -49
  98. package/.roo/commands/validate.md +283 -283
  99. package/.roo/commands/verify.md +222 -222
  100. package/AGENTS.md +175 -175
  101. package/CLAUDE.md +100 -100
  102. package/README.md +429 -416
  103. package/bin/forge-cmd.js +313 -313
  104. package/bin/forge-preflight.js +309 -309
  105. package/bin/forge.js +4596 -4303
  106. package/docs/AGENT_INSTALL_PROMPT.md +342 -342
  107. package/docs/BEADS_GITHUB_SYNC.md +251 -251
  108. package/docs/ENHANCED_ONBOARDING.md +602 -602
  109. package/docs/EXAMPLES.md +482 -482
  110. package/docs/GREPTILE_SETUP.md +400 -400
  111. package/docs/MANUAL_REVIEW_GUIDE.md +106 -106
  112. package/docs/ROADMAP.md +359 -359
  113. package/docs/SETUP.md +663 -631
  114. package/docs/TOOLCHAIN.md +630 -630
  115. package/docs/VALIDATION.md +363 -363
  116. package/install.sh +40 -1056
  117. package/lefthook.yml +39 -39
  118. package/lib/agents/README.md +198 -198
  119. package/lib/agents/claude.plugin.json +28 -28
  120. package/lib/agents/cline.plugin.json +22 -22
  121. package/lib/agents/codex.plugin.json +19 -19
  122. package/lib/agents/copilot.plugin.json +24 -24
  123. package/lib/agents/cursor.plugin.json +25 -25
  124. package/lib/agents/kilocode.plugin.json +22 -22
  125. package/lib/agents/opencode.plugin.json +20 -20
  126. package/lib/agents/roo.plugin.json +23 -23
  127. package/lib/agents-config.js +2112 -2112
  128. package/lib/beads-health-check.js +143 -0
  129. package/lib/beads-setup.js +341 -0
  130. package/lib/beads-sync-scaffold.js +260 -0
  131. package/lib/commands/dev.js +513 -513
  132. package/lib/commands/plan.js +692 -692
  133. package/lib/commands/recommend.js +119 -119
  134. package/lib/commands/ship.js +377 -377
  135. package/lib/commands/status.js +378 -378
  136. package/lib/commands/validate.js +602 -602
  137. package/lib/context-merge.js +359 -359
  138. package/lib/dep-guard/analyzer.js +294 -294
  139. package/lib/dep-guard/behavior-detector.js +98 -98
  140. package/lib/dep-guard/contract-detector.js +162 -162
  141. package/lib/dep-guard/import-detector.js +498 -498
  142. package/lib/dep-guard/path-utils.js +13 -13
  143. package/lib/dep-guard/rubric.js +120 -120
  144. package/lib/dep-guard/task-parser.js +318 -318
  145. package/lib/detect-agent.js +191 -191
  146. package/lib/detect-worktree.js +47 -47
  147. package/lib/file-hash.js +26 -26
  148. package/lib/husky-migration.js +450 -0
  149. package/lib/lefthook-check.js +65 -0
  150. package/lib/pat-setup.js +207 -0
  151. package/lib/plugin-catalog.js +350 -350
  152. package/lib/plugin-manager.js +166 -166
  153. package/lib/plugin-recommender.js +141 -141
  154. package/lib/project-discovery.js +491 -491
  155. package/lib/setup-action-log.js +139 -139
  156. package/lib/setup-summary-renderer.js +106 -106
  157. package/lib/setup-utils.js +96 -0
  158. package/lib/setup.js +192 -192
  159. package/lib/smart-merge.js +64 -0
  160. package/lib/symlink-utils.js +81 -0
  161. package/lib/workflow-profiles.js +197 -197
  162. package/package.json +131 -128
  163. package/scripts/beads-context.sh +291 -0
  164. package/scripts/beads-context.test.js +563 -0
  165. package/scripts/behavioral-judge.sh +378 -0
  166. package/scripts/benchmark.js +85 -0
  167. package/scripts/branch-protection.js +183 -0
  168. package/scripts/check-agents.js +172 -0
  169. package/scripts/commitlint.js +42 -0
  170. package/scripts/conflict-detect.sh +323 -0
  171. package/scripts/dep-guard-analyze.js +71 -0
  172. package/scripts/dep-guard.sh +811 -0
  173. package/scripts/eval_win.py +249 -0
  174. package/scripts/file-index.sh +399 -0
  175. package/scripts/github-beads-sync/comment.mjs +64 -0
  176. package/scripts/github-beads-sync/config.mjs +148 -0
  177. package/scripts/github-beads-sync/github-api.mjs +131 -0
  178. package/scripts/github-beads-sync/index.mjs +332 -0
  179. package/scripts/github-beads-sync/label-mapper.mjs +54 -0
  180. package/scripts/github-beads-sync/mapping.mjs +78 -0
  181. package/scripts/github-beads-sync/reverse-sync-cli.mjs +31 -0
  182. package/scripts/github-beads-sync/reverse-sync.mjs +138 -0
  183. package/scripts/github-beads-sync/run-bd.mjs +159 -0
  184. package/scripts/github-beads-sync/sanitize.mjs +121 -0
  185. package/scripts/github-beads-sync.config.json +26 -0
  186. package/scripts/improve-command.js +375 -0
  187. package/scripts/lib/eval-runner.js +229 -0
  188. package/scripts/lib/eval-schema.js +135 -0
  189. package/scripts/lib/eval-storage.js +78 -0
  190. package/scripts/lib/grading.js +203 -0
  191. package/scripts/lib/transcript-parser.js +63 -0
  192. package/scripts/lint.js +47 -0
  193. package/scripts/migrate-to-bun-test.js +412 -0
  194. package/scripts/run-command-eval.js +236 -0
  195. package/scripts/smart-status.sh +782 -0
  196. package/scripts/sync-commands.js +571 -0
  197. package/scripts/sync-utils.sh +460 -0
  198. package/scripts/test-dashboard.js +123 -0
  199. package/scripts/test.js +44 -0
  200. package/scripts/validate.sh +94 -0
  201. package/skills/parallel-deep-research/SKILL.md +108 -108
  202. package/skills/parallel-deep-research/evals/README.md +27 -27
  203. package/skills/parallel-deep-research/evals/evals.json +62 -62
  204. package/skills/sonarcloud-analysis/SKILL.md +171 -171
  205. package/skills/sonarcloud-analysis/evals/README.md +27 -27
  206. package/skills/sonarcloud-analysis/evals/evals.json +50 -50
  207. package/skills/sonarcloud-analysis/references/api-reference.md +466 -466
  208. package/.cursor/hooks/state/continual-learning-index.json +0 -19
  209. package/.cursor/hooks/state/continual-learning.json +0 -8
@@ -1,602 +1,602 @@
1
- # Enhanced Onboarding Guide
2
-
3
- Version 1.6.0 introduces intelligent onboarding that adapts to your project and preserves existing content.
4
-
5
- ---
6
-
7
- ## What's New in v1.6.0
8
-
9
- ### 🎯 Key Features
10
-
11
- 1. **Intelligent File Merging** - Preserves your existing AGENTS.md content
12
- 2. **Auto-Detection** - Automatically detects framework, language, and project stage
13
- 3. **Workflow Profiles** - Adapts workflow based on work type
14
- 4. **Context Storage** - Saves project context to `.forge/context.json`
15
-
16
- ---
17
-
18
- ## Intelligent File Merging
19
-
20
- When you run setup and already have an AGENTS.md file, Forge now offers three options:
21
-
22
- ### Option 1: Intelligent Merge (Recommended)
23
-
24
- Preserves your content while adding Forge workflow:
25
-
26
- ```bash
27
- bunx forge setup --merge=smart
28
- ```
29
-
30
- **What gets preserved:**
31
- - Project descriptions
32
- - Domain knowledge
33
- - Custom coding standards
34
- - Architecture notes
35
- - Tech stack details
36
-
37
- **What gets updated:**
38
- - Workflow instructions (9-stage TDD process)
39
- - TDD principles
40
- - Git conventions
41
-
42
- **Example:**
43
-
44
- Before (your existing AGENTS.md):
45
- ```markdown
46
- # My Project
47
-
48
- ## Project Description
49
- E-commerce platform for selling widgets.
50
-
51
- ## Coding Standards
52
- - TypeScript strict mode
53
- - 80% test coverage
54
- ```
55
-
56
- After intelligent merge:
57
- ```markdown
58
- # My Project
59
-
60
- ## Project Description
61
- E-commerce platform for selling widgets.
62
-
63
- ## Coding Standards
64
- - TypeScript strict mode
65
- - 80% test coverage
66
-
67
- ## Workflow Configuration
68
- Use the 9-stage TDD workflow:
69
- 1. /status - Check current context
70
- 2. /research - Research with web search
71
- ...
72
- ```
73
-
74
- ### Option 2: Keep Existing
75
-
76
- Skip Forge installation for AGENTS.md:
77
-
78
- ```bash
79
- # Select "Keep existing" when prompted
80
- # Or use:
81
- bunx forge setup --merge=preserve
82
- ```
83
-
84
- ### Option 3: Replace
85
-
86
- Overwrite with Forge standards (backup created):
87
-
88
- ```bash
89
- # Select "Replace" when prompted
90
- # Or use:
91
- bunx forge setup --merge=replace
92
- ```
93
-
94
- Your original file is backed up to `AGENTS.md.backup`
95
-
96
- ---
97
-
98
- ## Auto-Detection
99
-
100
- Forge automatically detects your project characteristics and saves them to `.forge/context.json`.
101
-
102
- ### What Gets Detected
103
-
104
- **Framework Detection:**
105
- - Next.js
106
- - React
107
- - Vue.js
108
- - Express
109
-
110
- **Language Detection:**
111
- - TypeScript (if in dependencies)
112
- - JavaScript (default)
113
-
114
- **Git Statistics:**
115
- - Commit count
116
- - Release tags
117
-
118
- **CI/CD Detection:**
119
- - GitHub Actions (`.github/workflows/`)
120
- - GitLab CI (`.gitlab-ci.yml`)
121
-
122
- **Project Stage Inference:**
123
- - **New**: < 50 commits, no CI/CD, low coverage
124
- - **Active**: 50-500 commits, has CI/CD, medium coverage
125
- - **Stable**: > 500 commits, has CI/CD + releases, high coverage
126
-
127
- ### Context Storage
128
-
129
- Detected context is saved to `.forge/context.json`:
130
-
131
- ```json
132
- {
133
- "auto_detected": {
134
- "framework": "Next.js",
135
- "language": "typescript",
136
- "stage": "active",
137
- "confidence": 0.85,
138
- "commits": 150,
139
- "hasCICD": true,
140
- "cicdType": "GitHub Actions",
141
- "hasReleases": false,
142
- "coverage": 65
143
- },
144
- "user_provided": {
145
- "description": "E-commerce platform",
146
- "current_work": "Adding multi-tenant support"
147
- },
148
- "last_updated": "2026-02-06T..."
149
- }
150
- ```
151
-
152
- ### Manual Override
153
-
154
- Force context interview to customize detected values:
155
-
156
- ```bash
157
- bunx forge setup --interview
158
- ```
159
-
160
- ---
161
-
162
- ## Workflow Profiles
163
-
164
- Forge adapts its workflow based on the type of work you're doing.
165
-
166
- ### Four User-Facing Types
167
-
168
- #### 1. Feature (Default)
169
- **Use for:** New functionality, enhancements
170
-
171
- ```bash
172
- bunx forge setup --type=feature
173
- # Or create branch: feat/user-dashboard
174
- ```
175
-
176
- **Workflow:**
177
- - Full 9-stage workflow
178
- - Auto-escalates to **Critical** if keywords detected:
179
- - auth, security, payment, crypto, password, token, session, migration, breaking
180
-
181
- **Critical Workflow (9 stages):**
182
- ```
183
- /status → /research → /plan → /dev → /validate → /ship → /review → /premerge → /verify
184
- ```
185
-
186
- **Standard Workflow (6 stages):**
187
- ```
188
- /status → /plan → /dev → /validate → /ship → /premerge
189
- ```
190
-
191
- #### 2. Fix
192
- **Use for:** Bug fixes, corrections
193
-
194
- ```bash
195
- bunx forge setup --type=fix
196
- # Or create branch: fix/login-validation
197
- ```
198
-
199
- **Workflow:**
200
- - Streamlined 5-stage workflow
201
- - Auto-escalates to **Hotfix** if keywords detected:
202
- - urgent, production, emergency, hotfix, critical
203
-
204
- **Hotfix Workflow (3 stages):**
205
- ```
206
- /dev → /validate → /ship
207
- ```
208
-
209
- **Simple Workflow (4 stages):**
210
- ```
211
- /dev → /validate → /ship → /premerge
212
- ```
213
-
214
- #### 3. Refactor
215
- **Use for:** Code cleanup, optimization
216
-
217
- ```bash
218
- bunx forge setup --type=refactor
219
- # Or create branch: refactor/extract-payment-service
220
- ```
221
-
222
- **Workflow (5 stages):**
223
- ```
224
- /plan → /dev → /validate → /ship → /premerge
225
- ```
226
-
227
- - Strict TDD to preserve behavior
228
- - Optional research for architectural changes
229
-
230
- #### 4. Chore
231
- **Use for:** Documentation, dependencies, configuration
232
-
233
- ```bash
234
- bunx forge setup --type=chore
235
- # Or create branch: docs/update-readme
236
- ```
237
-
238
- **Workflow (3 stages):**
239
- ```
240
- /verify → /ship → /premerge
241
- ```
242
-
243
- - Minimal workflow for maintenance tasks
244
- - Auto-detects if only markdown files changed → uses Docs profile
245
-
246
- ### Workflow Mapping
247
-
248
- | User Type | Keywords Detected | Internal Profile | Stages |
249
- |-----------|------------------|------------------|--------|
250
- | Feature | auth, security, payment | Critical | 9 |
251
- | Feature | (none) | Standard | 6 |
252
- | Fix | urgent, production | Hotfix | 3 |
253
- | Fix | (none) | Simple | 4 |
254
- | Refactor | (always) | Refactor | 5 |
255
- | Chore | only .md files | Docs | 3 |
256
-
257
- ---
258
-
259
- ## CLI Flags Reference
260
-
261
- ### Setup Flags
262
-
263
- ```bash
264
- # Merge strategy for existing files
265
- --merge <mode> smart, preserve, or replace
266
-
267
- # Workflow profile type
268
- --type <type> critical, standard, simple, hotfix, docs, refactor
269
-
270
- # Force context interview
271
- --interview Gather project information
272
-
273
- # Examples:
274
- bunx forge setup --merge=smart --type=critical --interview
275
- ```
276
-
277
- ### Complete Flag List
278
-
279
- ```bash
280
- --path, -p <dir> Target directory (default: current)
281
- --quick, -q Use all defaults
282
- --skip-external Skip external services
283
- --agents <list> Specify agents (--agents claude cursor)
284
- --all Install for all agents
285
- --merge <mode> Merge strategy (v1.6.0)
286
- --type <type> Workflow profile (v1.6.0)
287
- --interview Context interview (v1.6.0)
288
- --help, -h Show help
289
- ```
290
-
291
- ---
292
-
293
- ## Usage Examples
294
-
295
- ### Scenario 1: Fresh Project
296
-
297
- ```bash
298
- # New project, auto-detect everything
299
- bunx forge setup
300
-
301
- # What happens:
302
- # 1. Detects Next.js + TypeScript
303
- # 2. Saves to .forge/context.json
304
- # 3. Creates AGENTS.md with detected info
305
- # 4. Sets up agent-specific files
306
- ```
307
-
308
- ### Scenario 2: Existing AGENTS.md
309
-
310
- ```bash
311
- # Project with custom AGENTS.md
312
- bunx forge setup
313
-
314
- # You'll be prompted:
315
- # > Found existing AGENTS.md without Forge markers.
316
- # >
317
- # > How would you like to proceed?
318
- # > 1. Intelligent merge (preserve your content + add Forge workflow)
319
- # > 2. Keep existing (skip Forge installation for this file)
320
- # > 3. Replace (backup created at AGENTS.md.backup)
321
- # >
322
- # > Your choice (1-3) [1]:
323
-
324
- # Choose 1 for intelligent merge
325
- ```
326
-
327
- ### Scenario 3: Security Feature
328
-
329
- ```bash
330
- # Authentication feature
331
- git checkout -b feat/user-authentication
332
-
333
- bunx forge setup --type=critical
334
-
335
- # Auto-escalates to Critical profile:
336
- # - 7-stage workflow
337
- # - Research required
338
- # - OWASP analysis
339
- # - Design docs for strategic changes
340
- ```
341
-
342
- ### Scenario 4: Production Hotfix
343
-
344
- ```bash
345
- # Urgent production bug
346
- git checkout -b hotfix/payment-crash
347
-
348
- bunx forge setup --type=hotfix
349
-
350
- # Uses Hotfix profile:
351
- # - 3-stage emergency workflow
352
- # - TDD to reproduce bug
353
- # - Skip research and planning
354
- # - Fast path to production
355
- ```
356
-
357
- ### Scenario 5: Documentation Update
358
-
359
- ```bash
360
- # Update README
361
- git checkout -b docs/update-installation-guide
362
-
363
- # Forge auto-detects chore → docs profile:
364
- # - 3-stage minimal workflow
365
- # - No TDD required
366
- # - Just verify, ship, merge
367
- ```
368
-
369
- ---
370
-
371
- ## Migration Guide
372
-
373
- ### Upgrading from v1.5.0 to v1.6.0
374
-
375
- **No breaking changes!** Enhanced onboarding is backwards compatible.
376
-
377
- **What's new:**
378
- 1. Enhanced file merging options
379
- 2. Auto-detection and context storage
380
- 3. Workflow profiles with auto-escalation
381
-
382
- **What stays the same:**
383
- - Existing marker-based merge (USER:START/END) still works
384
- - All CLI flags from v1.5.0 remain functional
385
- - AGENTS.md format unchanged
386
-
387
- **Recommended steps:**
388
- ```bash
389
- # 1. Pull latest version
390
- bun update forge-workflow
391
-
392
- # 2. Re-run setup to enable new features
393
- bunx forge setup
394
-
395
- # 3. Check auto-detected context
396
- cat .forge/context.json
397
-
398
- # 4. Review merged AGENTS.md
399
- cat AGENTS.md
400
- ```
401
-
402
- ---
403
-
404
- ## Troubleshooting
405
-
406
- ### Issue: Auto-detection failed
407
-
408
- ```bash
409
- # Error: "Auto-detection skipped (error: ...)"
410
- ```
411
-
412
- **Solution:** Auto-detection is optional. Setup continues with defaults.
413
-
414
- To manually specify:
415
- ```bash
416
- bunx forge setup --interview
417
- ```
418
-
419
- ### Issue: Merge didn't preserve my content
420
-
421
- ```bash
422
- # Some content missing after merge
423
- ```
424
-
425
- **Solution:** Check backup file:
426
- ```bash
427
- cat AGENTS.md.backup
428
- ```
429
-
430
- Re-run with preserve mode:
431
- ```bash
432
- bunx forge setup --merge=preserve
433
- ```
434
-
435
- Manually merge using semantic merge tool:
436
- ```javascript
437
- const contextMerge = require('forge-workflow/lib/context-merge');
438
- const merged = contextMerge.semanticMerge(existingContent, forgeContent);
439
- ```
440
-
441
- ### Issue: Wrong workflow profile detected
442
-
443
- ```bash
444
- # Branch: feat/add-button
445
- # Detected: standard
446
- # Expected: simple
447
- ```
448
-
449
- **Solution:** Override detection:
450
- ```bash
451
- bunx forge setup --type=simple
452
- ```
453
-
454
- Or update branch name to match convention:
455
- ```bash
456
- git branch -m feat/simple-add-button
457
- ```
458
-
459
- ### Issue: Context not saved
460
-
461
- ```bash
462
- # .forge/context.json not created
463
- ```
464
-
465
- **Solution:** Check write permissions:
466
- ```bash
467
- ls -la .forge/
468
- ```
469
-
470
- Create manually:
471
- ```bash
472
- mkdir -p .forge
473
- bunx forge setup
474
- ```
475
-
476
- ---
477
-
478
- ## Advanced Usage
479
-
480
- ### Custom Context
481
-
482
- Edit `.forge/context.json` to add custom fields:
483
-
484
- ```json
485
- {
486
- "auto_detected": { ... },
487
- "user_provided": {
488
- "description": "SaaS platform for team collaboration",
489
- "current_work": "Adding real-time notifications",
490
- "tech_stack": {
491
- "backend": "Node.js + Express + PostgreSQL",
492
- "frontend": "Next.js + TailwindCSS",
493
- "infrastructure": "AWS ECS + RDS"
494
- },
495
- "team_conventions": {
496
- "branch_naming": "type/JIRA-123-description",
497
- "commit_format": "conventional commits",
498
- "review_process": "2 approvals required"
499
- }
500
- },
501
- "last_updated": "2026-02-06T..."
502
- }
503
- ```
504
-
505
- ### Workflow Profile Customization
506
-
507
- Override specific stages:
508
-
509
- ```bash
510
- # Feature workflow but skip research
511
- bunx forge setup --type=standard
512
-
513
- # Then manually edit AGENTS.md to customize workflow
514
- ```
515
-
516
- ### Multiple Profiles
517
-
518
- Different profiles for different branches:
519
-
520
- ```bash
521
- # Main features
522
- git checkout -b feat/dashboard
523
- bunx forge setup --type=standard
524
-
525
- # Security features
526
- git checkout -b feat/auth-oauth
527
- bunx forge setup --type=critical
528
-
529
- # Quick fixes
530
- git checkout -b fix/typo
531
- bunx forge setup --type=simple
532
- ```
533
-
534
- ---
535
-
536
- ## Best Practices
537
-
538
- ### 1. Let Auto-Detection Work
539
-
540
- Don't override unless necessary. Auto-detection is smart:
541
- - Analyzes your actual codebase
542
- - Considers project maturity
543
- - Detects CI/CD and testing setup
544
-
545
- ### 2. Use Intelligent Merge
546
-
547
- When upgrading existing projects:
548
- - Choose "Intelligent merge" (option 1)
549
- - Preserves your domain knowledge
550
- - Adds Forge workflow standards
551
-
552
- ### 3. Set Workflow Type Per Branch
553
-
554
- Different branches, different workflows:
555
- - `feat/auth-*` → critical
556
- - `feat/ui-*` → standard
557
- - `fix/*` → simple
558
- - `docs/*` → chore
559
-
560
- ### 4. Review Context Regularly
561
-
562
- ```bash
563
- # Check what Forge knows about your project
564
- cat .forge/context.json
565
-
566
- # Update if project changed significantly
567
- bunx forge setup --interview
568
- ```
569
-
570
- ### 5. Commit Context File
571
-
572
- Add `.forge/context.json` to git:
573
- ```bash
574
- git add .forge/context.json
575
- git commit -m "docs: update project context"
576
- ```
577
-
578
- Share project knowledge with team.
579
-
580
- ---
581
-
582
- ## Related Documentation
583
-
584
- - [Main README](../README.md) - Overview and quick start
585
- - [Workflow Guide](../AGENTS.md) - Complete 7-stage workflow
586
- - [Setup Guide](SETUP.md) - Agent-specific setup
587
- - [Agent Install Prompt](AGENT_INSTALL_PROMPT.md) - AI-assisted setup
588
-
589
- ---
590
-
591
- ## Feedback
592
-
593
- Found an issue or have a suggestion?
594
- - [Report on GitHub](https://github.com/harshanandak/forge/issues)
595
- - Tag with `enhancement` for feature requests
596
- - Tag with `bug` for issues
597
-
598
- ---
599
-
600
- **Version**: 1.6.0
601
- **Last Updated**: 2026-02-06
602
- **Stability**: Stable
1
+ # Enhanced Onboarding Guide
2
+
3
+ Version 1.6.0 introduces intelligent onboarding that adapts to your project and preserves existing content.
4
+
5
+ ---
6
+
7
+ ## What's New in v1.6.0
8
+
9
+ ### 🎯 Key Features
10
+
11
+ 1. **Intelligent File Merging** - Preserves your existing AGENTS.md content
12
+ 2. **Auto-Detection** - Automatically detects framework, language, and project stage
13
+ 3. **Workflow Profiles** - Adapts workflow based on work type
14
+ 4. **Context Storage** - Saves project context to `.forge/context.json`
15
+
16
+ ---
17
+
18
+ ## Intelligent File Merging
19
+
20
+ When you run setup and already have an AGENTS.md file, Forge now offers three options:
21
+
22
+ ### Option 1: Intelligent Merge (Recommended)
23
+
24
+ Preserves your content while adding Forge workflow:
25
+
26
+ ```bash
27
+ bunx forge setup --merge=smart
28
+ ```
29
+
30
+ **What gets preserved:**
31
+ - Project descriptions
32
+ - Domain knowledge
33
+ - Custom coding standards
34
+ - Architecture notes
35
+ - Tech stack details
36
+
37
+ **What gets updated:**
38
+ - Workflow instructions (9-stage TDD process)
39
+ - TDD principles
40
+ - Git conventions
41
+
42
+ **Example:**
43
+
44
+ Before (your existing AGENTS.md):
45
+ ```markdown
46
+ # My Project
47
+
48
+ ## Project Description
49
+ E-commerce platform for selling widgets.
50
+
51
+ ## Coding Standards
52
+ - TypeScript strict mode
53
+ - 80% test coverage
54
+ ```
55
+
56
+ After intelligent merge:
57
+ ```markdown
58
+ # My Project
59
+
60
+ ## Project Description
61
+ E-commerce platform for selling widgets.
62
+
63
+ ## Coding Standards
64
+ - TypeScript strict mode
65
+ - 80% test coverage
66
+
67
+ ## Workflow Configuration
68
+ Use the 9-stage TDD workflow:
69
+ 1. /status - Check current context
70
+ 2. /research - Research with web search
71
+ ...
72
+ ```
73
+
74
+ ### Option 2: Keep Existing
75
+
76
+ Skip Forge installation for AGENTS.md:
77
+
78
+ ```bash
79
+ # Select "Keep existing" when prompted
80
+ # Or use:
81
+ bunx forge setup --merge=preserve
82
+ ```
83
+
84
+ ### Option 3: Replace
85
+
86
+ Overwrite with Forge standards (backup created):
87
+
88
+ ```bash
89
+ # Select "Replace" when prompted
90
+ # Or use:
91
+ bunx forge setup --merge=replace
92
+ ```
93
+
94
+ Your original file is backed up to `AGENTS.md.backup`
95
+
96
+ ---
97
+
98
+ ## Auto-Detection
99
+
100
+ Forge automatically detects your project characteristics and saves them to `.forge/context.json`.
101
+
102
+ ### What Gets Detected
103
+
104
+ **Framework Detection:**
105
+ - Next.js
106
+ - React
107
+ - Vue.js
108
+ - Express
109
+
110
+ **Language Detection:**
111
+ - TypeScript (if in dependencies)
112
+ - JavaScript (default)
113
+
114
+ **Git Statistics:**
115
+ - Commit count
116
+ - Release tags
117
+
118
+ **CI/CD Detection:**
119
+ - GitHub Actions (`.github/workflows/`)
120
+ - GitLab CI (`.gitlab-ci.yml`)
121
+
122
+ **Project Stage Inference:**
123
+ - **New**: < 50 commits, no CI/CD, low coverage
124
+ - **Active**: 50-500 commits, has CI/CD, medium coverage
125
+ - **Stable**: > 500 commits, has CI/CD + releases, high coverage
126
+
127
+ ### Context Storage
128
+
129
+ Detected context is saved to `.forge/context.json`:
130
+
131
+ ```json
132
+ {
133
+ "auto_detected": {
134
+ "framework": "Next.js",
135
+ "language": "typescript",
136
+ "stage": "active",
137
+ "confidence": 0.85,
138
+ "commits": 150,
139
+ "hasCICD": true,
140
+ "cicdType": "GitHub Actions",
141
+ "hasReleases": false,
142
+ "coverage": 65
143
+ },
144
+ "user_provided": {
145
+ "description": "E-commerce platform",
146
+ "current_work": "Adding multi-tenant support"
147
+ },
148
+ "last_updated": "2026-02-06T..."
149
+ }
150
+ ```
151
+
152
+ ### Manual Override
153
+
154
+ Force context interview to customize detected values:
155
+
156
+ ```bash
157
+ bunx forge setup --interview
158
+ ```
159
+
160
+ ---
161
+
162
+ ## Workflow Profiles
163
+
164
+ Forge adapts its workflow based on the type of work you're doing.
165
+
166
+ ### Four User-Facing Types
167
+
168
+ #### 1. Feature (Default)
169
+ **Use for:** New functionality, enhancements
170
+
171
+ ```bash
172
+ bunx forge setup --type=feature
173
+ # Or create branch: feat/user-dashboard
174
+ ```
175
+
176
+ **Workflow:**
177
+ - Full 9-stage workflow
178
+ - Auto-escalates to **Critical** if keywords detected:
179
+ - auth, security, payment, crypto, password, token, session, migration, breaking
180
+
181
+ **Critical Workflow (9 stages):**
182
+ ```
183
+ /status → /research → /plan → /dev → /validate → /ship → /review → /premerge → /verify
184
+ ```
185
+
186
+ **Standard Workflow (6 stages):**
187
+ ```
188
+ /status → /plan → /dev → /validate → /ship → /premerge
189
+ ```
190
+
191
+ #### 2. Fix
192
+ **Use for:** Bug fixes, corrections
193
+
194
+ ```bash
195
+ bunx forge setup --type=fix
196
+ # Or create branch: fix/login-validation
197
+ ```
198
+
199
+ **Workflow:**
200
+ - Streamlined 5-stage workflow
201
+ - Auto-escalates to **Hotfix** if keywords detected:
202
+ - urgent, production, emergency, hotfix, critical
203
+
204
+ **Hotfix Workflow (3 stages):**
205
+ ```
206
+ /dev → /validate → /ship
207
+ ```
208
+
209
+ **Simple Workflow (4 stages):**
210
+ ```
211
+ /dev → /validate → /ship → /premerge
212
+ ```
213
+
214
+ #### 3. Refactor
215
+ **Use for:** Code cleanup, optimization
216
+
217
+ ```bash
218
+ bunx forge setup --type=refactor
219
+ # Or create branch: refactor/extract-payment-service
220
+ ```
221
+
222
+ **Workflow (5 stages):**
223
+ ```
224
+ /plan → /dev → /validate → /ship → /premerge
225
+ ```
226
+
227
+ - Strict TDD to preserve behavior
228
+ - Optional research for architectural changes
229
+
230
+ #### 4. Chore
231
+ **Use for:** Documentation, dependencies, configuration
232
+
233
+ ```bash
234
+ bunx forge setup --type=chore
235
+ # Or create branch: docs/update-readme
236
+ ```
237
+
238
+ **Workflow (3 stages):**
239
+ ```
240
+ /verify → /ship → /premerge
241
+ ```
242
+
243
+ - Minimal workflow for maintenance tasks
244
+ - Auto-detects if only markdown files changed → uses Docs profile
245
+
246
+ ### Workflow Mapping
247
+
248
+ | User Type | Keywords Detected | Internal Profile | Stages |
249
+ |-----------|------------------|------------------|--------|
250
+ | Feature | auth, security, payment | Critical | 9 |
251
+ | Feature | (none) | Standard | 6 |
252
+ | Fix | urgent, production | Hotfix | 3 |
253
+ | Fix | (none) | Simple | 4 |
254
+ | Refactor | (always) | Refactor | 5 |
255
+ | Chore | only .md files | Docs | 3 |
256
+
257
+ ---
258
+
259
+ ## CLI Flags Reference
260
+
261
+ ### Setup Flags
262
+
263
+ ```bash
264
+ # Merge strategy for existing files
265
+ --merge <mode> smart, preserve, or replace
266
+
267
+ # Workflow profile type
268
+ --type <type> critical, standard, simple, hotfix, docs, refactor
269
+
270
+ # Force context interview
271
+ --interview Gather project information
272
+
273
+ # Examples:
274
+ bunx forge setup --merge=smart --type=critical --interview
275
+ ```
276
+
277
+ ### Complete Flag List
278
+
279
+ ```bash
280
+ --path, -p <dir> Target directory (default: current)
281
+ --quick, -q Use all defaults
282
+ --skip-external Skip external services
283
+ --agents <list> Specify agents (--agents claude cursor)
284
+ --all Install for all agents
285
+ --merge <mode> Merge strategy (v1.6.0)
286
+ --type <type> Workflow profile (v1.6.0)
287
+ --interview Context interview (v1.6.0)
288
+ --help, -h Show help
289
+ ```
290
+
291
+ ---
292
+
293
+ ## Usage Examples
294
+
295
+ ### Scenario 1: Fresh Project
296
+
297
+ ```bash
298
+ # New project, auto-detect everything
299
+ bunx forge setup
300
+
301
+ # What happens:
302
+ # 1. Detects Next.js + TypeScript
303
+ # 2. Saves to .forge/context.json
304
+ # 3. Creates AGENTS.md with detected info
305
+ # 4. Sets up agent-specific files
306
+ ```
307
+
308
+ ### Scenario 2: Existing AGENTS.md
309
+
310
+ ```bash
311
+ # Project with custom AGENTS.md
312
+ bunx forge setup
313
+
314
+ # You'll be prompted:
315
+ # > Found existing AGENTS.md without Forge markers.
316
+ # >
317
+ # > How would you like to proceed?
318
+ # > 1. Intelligent merge (preserve your content + add Forge workflow)
319
+ # > 2. Keep existing (skip Forge installation for this file)
320
+ # > 3. Replace (backup created at AGENTS.md.backup)
321
+ # >
322
+ # > Your choice (1-3) [1]:
323
+
324
+ # Choose 1 for intelligent merge
325
+ ```
326
+
327
+ ### Scenario 3: Security Feature
328
+
329
+ ```bash
330
+ # Authentication feature
331
+ git checkout -b feat/user-authentication
332
+
333
+ bunx forge setup --type=critical
334
+
335
+ # Auto-escalates to Critical profile:
336
+ # - 7-stage workflow
337
+ # - Research required
338
+ # - OWASP analysis
339
+ # - Design docs for strategic changes
340
+ ```
341
+
342
+ ### Scenario 4: Production Hotfix
343
+
344
+ ```bash
345
+ # Urgent production bug
346
+ git checkout -b hotfix/payment-crash
347
+
348
+ bunx forge setup --type=hotfix
349
+
350
+ # Uses Hotfix profile:
351
+ # - 3-stage emergency workflow
352
+ # - TDD to reproduce bug
353
+ # - Skip research and planning
354
+ # - Fast path to production
355
+ ```
356
+
357
+ ### Scenario 5: Documentation Update
358
+
359
+ ```bash
360
+ # Update README
361
+ git checkout -b docs/update-installation-guide
362
+
363
+ # Forge auto-detects chore → docs profile:
364
+ # - 3-stage minimal workflow
365
+ # - No TDD required
366
+ # - Just verify, ship, merge
367
+ ```
368
+
369
+ ---
370
+
371
+ ## Migration Guide
372
+
373
+ ### Upgrading from v1.5.0 to v1.6.0
374
+
375
+ **No breaking changes!** Enhanced onboarding is backwards compatible.
376
+
377
+ **What's new:**
378
+ 1. Enhanced file merging options
379
+ 2. Auto-detection and context storage
380
+ 3. Workflow profiles with auto-escalation
381
+
382
+ **What stays the same:**
383
+ - Existing marker-based merge (USER:START/END) still works
384
+ - All CLI flags from v1.5.0 remain functional
385
+ - AGENTS.md format unchanged
386
+
387
+ **Recommended steps:**
388
+ ```bash
389
+ # 1. Pull latest version
390
+ bun update forge-workflow
391
+
392
+ # 2. Re-run setup to enable new features
393
+ bunx forge setup
394
+
395
+ # 3. Check auto-detected context
396
+ cat .forge/context.json
397
+
398
+ # 4. Review merged AGENTS.md
399
+ cat AGENTS.md
400
+ ```
401
+
402
+ ---
403
+
404
+ ## Troubleshooting
405
+
406
+ ### Issue: Auto-detection failed
407
+
408
+ ```bash
409
+ # Error: "Auto-detection skipped (error: ...)"
410
+ ```
411
+
412
+ **Solution:** Auto-detection is optional. Setup continues with defaults.
413
+
414
+ To manually specify:
415
+ ```bash
416
+ bunx forge setup --interview
417
+ ```
418
+
419
+ ### Issue: Merge didn't preserve my content
420
+
421
+ ```bash
422
+ # Some content missing after merge
423
+ ```
424
+
425
+ **Solution:** Check backup file:
426
+ ```bash
427
+ cat AGENTS.md.backup
428
+ ```
429
+
430
+ Re-run with preserve mode:
431
+ ```bash
432
+ bunx forge setup --merge=preserve
433
+ ```
434
+
435
+ Manually merge using semantic merge tool:
436
+ ```javascript
437
+ const contextMerge = require('forge-workflow/lib/context-merge');
438
+ const merged = contextMerge.semanticMerge(existingContent, forgeContent);
439
+ ```
440
+
441
+ ### Issue: Wrong workflow profile detected
442
+
443
+ ```bash
444
+ # Branch: feat/add-button
445
+ # Detected: standard
446
+ # Expected: simple
447
+ ```
448
+
449
+ **Solution:** Override detection:
450
+ ```bash
451
+ bunx forge setup --type=simple
452
+ ```
453
+
454
+ Or update branch name to match convention:
455
+ ```bash
456
+ git branch -m feat/simple-add-button
457
+ ```
458
+
459
+ ### Issue: Context not saved
460
+
461
+ ```bash
462
+ # .forge/context.json not created
463
+ ```
464
+
465
+ **Solution:** Check write permissions:
466
+ ```bash
467
+ ls -la .forge/
468
+ ```
469
+
470
+ Create manually:
471
+ ```bash
472
+ mkdir -p .forge
473
+ bunx forge setup
474
+ ```
475
+
476
+ ---
477
+
478
+ ## Advanced Usage
479
+
480
+ ### Custom Context
481
+
482
+ Edit `.forge/context.json` to add custom fields:
483
+
484
+ ```json
485
+ {
486
+ "auto_detected": { ... },
487
+ "user_provided": {
488
+ "description": "SaaS platform for team collaboration",
489
+ "current_work": "Adding real-time notifications",
490
+ "tech_stack": {
491
+ "backend": "Node.js + Express + PostgreSQL",
492
+ "frontend": "Next.js + TailwindCSS",
493
+ "infrastructure": "AWS ECS + RDS"
494
+ },
495
+ "team_conventions": {
496
+ "branch_naming": "type/JIRA-123-description",
497
+ "commit_format": "conventional commits",
498
+ "review_process": "2 approvals required"
499
+ }
500
+ },
501
+ "last_updated": "2026-02-06T..."
502
+ }
503
+ ```
504
+
505
+ ### Workflow Profile Customization
506
+
507
+ Override specific stages:
508
+
509
+ ```bash
510
+ # Feature workflow but skip research
511
+ bunx forge setup --type=standard
512
+
513
+ # Then manually edit AGENTS.md to customize workflow
514
+ ```
515
+
516
+ ### Multiple Profiles
517
+
518
+ Different profiles for different branches:
519
+
520
+ ```bash
521
+ # Main features
522
+ git checkout -b feat/dashboard
523
+ bunx forge setup --type=standard
524
+
525
+ # Security features
526
+ git checkout -b feat/auth-oauth
527
+ bunx forge setup --type=critical
528
+
529
+ # Quick fixes
530
+ git checkout -b fix/typo
531
+ bunx forge setup --type=simple
532
+ ```
533
+
534
+ ---
535
+
536
+ ## Best Practices
537
+
538
+ ### 1. Let Auto-Detection Work
539
+
540
+ Don't override unless necessary. Auto-detection is smart:
541
+ - Analyzes your actual codebase
542
+ - Considers project maturity
543
+ - Detects CI/CD and testing setup
544
+
545
+ ### 2. Use Intelligent Merge
546
+
547
+ When upgrading existing projects:
548
+ - Choose "Intelligent merge" (option 1)
549
+ - Preserves your domain knowledge
550
+ - Adds Forge workflow standards
551
+
552
+ ### 3. Set Workflow Type Per Branch
553
+
554
+ Different branches, different workflows:
555
+ - `feat/auth-*` → critical
556
+ - `feat/ui-*` → standard
557
+ - `fix/*` → simple
558
+ - `docs/*` → chore
559
+
560
+ ### 4. Review Context Regularly
561
+
562
+ ```bash
563
+ # Check what Forge knows about your project
564
+ cat .forge/context.json
565
+
566
+ # Update if project changed significantly
567
+ bunx forge setup --interview
568
+ ```
569
+
570
+ ### 5. Commit Context File
571
+
572
+ Add `.forge/context.json` to git:
573
+ ```bash
574
+ git add .forge/context.json
575
+ git commit -m "docs: update project context"
576
+ ```
577
+
578
+ Share project knowledge with team.
579
+
580
+ ---
581
+
582
+ ## Related Documentation
583
+
584
+ - [Main README](../README.md) - Overview and quick start
585
+ - [Workflow Guide](../AGENTS.md) - Complete 7-stage workflow
586
+ - [Setup Guide](SETUP.md) - Agent-specific setup
587
+ - [Agent Install Prompt](AGENT_INSTALL_PROMPT.md) - AI-assisted setup
588
+
589
+ ---
590
+
591
+ ## Feedback
592
+
593
+ Found an issue or have a suggestion?
594
+ - [Report on GitHub](https://github.com/harshanandak/forge/issues)
595
+ - Tag with `enhancement` for feature requests
596
+ - Tag with `bug` for issues
597
+
598
+ ---
599
+
600
+ **Version**: 1.6.0
601
+ **Last Updated**: 2026-02-06
602
+ **Stability**: Stable