forge-workflow 0.0.4 → 0.0.6

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 (248) hide show
  1. package/.claude/commands/dev.md +345 -340
  2. package/.claude/commands/plan.md +566 -521
  3. package/.claude/commands/premerge.md +186 -176
  4. package/.claude/commands/research.md +42 -42
  5. package/.claude/commands/review.md +448 -442
  6. package/.claude/commands/rollback.md +721 -721
  7. package/.claude/commands/ship.md +212 -164
  8. package/.claude/commands/sonarcloud.md +152 -152
  9. package/.claude/commands/status.md +90 -48
  10. package/.claude/commands/validate.md +288 -282
  11. package/.claude/commands/verify.md +269 -221
  12. package/.claude/rules/greptile-review-process.md +285 -285
  13. package/.claude/rules/workflow.md +121 -105
  14. package/.claude/scripts/greptile-resolve.sh +558 -526
  15. package/.claude/scripts/load-env.sh +32 -32
  16. package/.cline/workflows/dev.md +342 -337
  17. package/.cline/workflows/plan.md +563 -518
  18. package/.cline/workflows/premerge.md +183 -173
  19. package/.cline/workflows/research.md +39 -39
  20. package/.cline/workflows/review.md +445 -439
  21. package/.cline/workflows/rollback.md +718 -718
  22. package/.cline/workflows/ship.md +209 -161
  23. package/.cline/workflows/sonarcloud.md +146 -146
  24. package/.cline/workflows/status.md +87 -45
  25. package/.cline/workflows/validate.md +285 -279
  26. package/.cline/workflows/verify.md +266 -218
  27. package/.codex/config.toml +11 -11
  28. package/.codex/skills/dev/SKILL.md +345 -340
  29. package/.codex/skills/plan/SKILL.md +566 -521
  30. package/.codex/skills/premerge/SKILL.md +186 -176
  31. package/.codex/skills/research/SKILL.md +42 -42
  32. package/.codex/skills/review/SKILL.md +448 -442
  33. package/.codex/skills/rollback/SKILL.md +721 -721
  34. package/.codex/skills/ship/SKILL.md +212 -164
  35. package/.codex/skills/sonarcloud/SKILL.md +149 -149
  36. package/.codex/skills/status/SKILL.md +90 -48
  37. package/.codex/skills/validate/SKILL.md +288 -282
  38. package/.codex/skills/verify/SKILL.md +269 -221
  39. package/.cursor/commands/dev.md +342 -337
  40. package/.cursor/commands/plan.md +563 -518
  41. package/.cursor/commands/premerge.md +183 -173
  42. package/.cursor/commands/research.md +39 -39
  43. package/.cursor/commands/review.md +445 -439
  44. package/.cursor/commands/rollback.md +718 -718
  45. package/.cursor/commands/ship.md +209 -161
  46. package/.cursor/commands/sonarcloud.md +146 -146
  47. package/.cursor/commands/status.md +87 -45
  48. package/.cursor/commands/validate.md +285 -279
  49. package/.cursor/commands/verify.md +266 -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 +347 -342
  54. package/.github/prompts/plan.prompt.md +568 -523
  55. package/.github/prompts/premerge.prompt.md +188 -178
  56. package/.github/prompts/research.prompt.md +44 -44
  57. package/.github/prompts/review.prompt.md +450 -444
  58. package/.github/prompts/rollback.prompt.md +723 -723
  59. package/.github/prompts/ship.prompt.md +214 -166
  60. package/.github/prompts/sonarcloud.prompt.md +151 -151
  61. package/.github/prompts/status.prompt.md +92 -50
  62. package/.github/prompts/validate.prompt.md +290 -284
  63. package/.github/prompts/verify.prompt.md +271 -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 +346 -341
  67. package/.kilocode/workflows/plan.md +567 -522
  68. package/.kilocode/workflows/premerge.md +187 -177
  69. package/.kilocode/workflows/research.md +43 -43
  70. package/.kilocode/workflows/review.md +449 -443
  71. package/.kilocode/workflows/rollback.md +722 -722
  72. package/.kilocode/workflows/ship.md +213 -165
  73. package/.kilocode/workflows/sonarcloud.md +150 -150
  74. package/.kilocode/workflows/status.md +91 -49
  75. package/.kilocode/workflows/validate.md +289 -283
  76. package/.kilocode/workflows/verify.md +270 -222
  77. package/.mcp.json.example +12 -12
  78. package/.opencode/commands/dev.md +345 -340
  79. package/.opencode/commands/plan.md +566 -521
  80. package/.opencode/commands/premerge.md +186 -176
  81. package/.opencode/commands/research.md +42 -42
  82. package/.opencode/commands/review.md +448 -442
  83. package/.opencode/commands/rollback.md +721 -721
  84. package/.opencode/commands/ship.md +212 -164
  85. package/.opencode/commands/sonarcloud.md +149 -149
  86. package/.opencode/commands/status.md +90 -48
  87. package/.opencode/commands/validate.md +288 -282
  88. package/.opencode/commands/verify.md +269 -221
  89. package/.roo/commands/dev.md +346 -341
  90. package/.roo/commands/plan.md +567 -522
  91. package/.roo/commands/premerge.md +187 -177
  92. package/.roo/commands/research.md +43 -43
  93. package/.roo/commands/review.md +449 -443
  94. package/.roo/commands/rollback.md +722 -722
  95. package/.roo/commands/ship.md +213 -165
  96. package/.roo/commands/sonarcloud.md +150 -150
  97. package/.roo/commands/status.md +91 -49
  98. package/.roo/commands/validate.md +289 -283
  99. package/.roo/commands/verify.md +270 -222
  100. package/AGENTS.md +272 -175
  101. package/CLAUDE.md +110 -100
  102. package/README.md +429 -416
  103. package/bin/forge-cmd.js +317 -313
  104. package/bin/forge-preflight.js +322 -309
  105. package/bin/forge.js +4765 -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 +612 -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 +653 -630
  115. package/docs/VALIDATION.md +363 -363
  116. package/install.sh +40 -1056
  117. package/lefthook.yml +50 -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/_registry.js +134 -0
  132. package/lib/commands/clean.js +181 -0
  133. package/lib/commands/dev.js +571 -513
  134. package/lib/commands/plan.js +692 -692
  135. package/lib/commands/push.js +196 -0
  136. package/lib/commands/recommend.js +119 -119
  137. package/lib/commands/ship.js +377 -377
  138. package/lib/commands/status.js +378 -378
  139. package/lib/commands/sync.js +55 -0
  140. package/lib/commands/team.js +37 -0
  141. package/lib/commands/test.js +207 -0
  142. package/lib/commands/validate.js +602 -602
  143. package/lib/commands/worktree.js +310 -0
  144. package/lib/context-merge.js +359 -359
  145. package/lib/dep-guard/analyzer.js +294 -294
  146. package/lib/dep-guard/behavior-detector.js +98 -98
  147. package/lib/dep-guard/contract-detector.js +162 -162
  148. package/lib/dep-guard/import-detector.js +498 -498
  149. package/lib/dep-guard/path-utils.js +13 -13
  150. package/lib/dep-guard/rubric.js +120 -120
  151. package/lib/dep-guard/task-parser.js +318 -318
  152. package/lib/detect-agent.js +191 -191
  153. package/lib/detect-worktree.js +47 -47
  154. package/lib/docs-command.js +51 -0
  155. package/lib/docs-copy.js +50 -0
  156. package/lib/file-hash.js +26 -26
  157. package/lib/freshness-token.js +148 -0
  158. package/lib/greptile-match.js +80 -0
  159. package/lib/husky-migration.js +450 -0
  160. package/lib/lefthook-check.js +65 -0
  161. package/lib/pat-setup.js +207 -0
  162. package/lib/plugin-catalog.js +350 -350
  163. package/lib/plugin-manager.js +166 -166
  164. package/lib/plugin-recommender.js +141 -141
  165. package/lib/project-discovery.js +491 -491
  166. package/lib/reset.js +309 -0
  167. package/lib/setup-action-log.js +139 -139
  168. package/lib/setup-summary-renderer.js +106 -106
  169. package/lib/setup-utils.js +96 -0
  170. package/lib/setup.js +192 -192
  171. package/lib/smart-merge.js +64 -0
  172. package/lib/symlink-utils.js +81 -0
  173. package/lib/task-ownership.js +117 -0
  174. package/lib/workflow-profiles.js +197 -197
  175. package/package.json +131 -128
  176. package/scripts/beads-context.sh +426 -0
  177. package/scripts/beads-context.test.js +567 -0
  178. package/scripts/behavioral-judge.sh +378 -0
  179. package/scripts/benchmark.js +85 -0
  180. package/scripts/branch-protection.js +183 -0
  181. package/scripts/check-agents.js +172 -0
  182. package/scripts/check-forge-token.js +98 -0
  183. package/scripts/commitlint.js +42 -0
  184. package/scripts/conflict-detect.sh +323 -0
  185. package/scripts/dep-guard-analyze.js +71 -0
  186. package/scripts/dep-guard.sh +789 -0
  187. package/scripts/eval_win.py +249 -0
  188. package/scripts/file-index.sh +493 -0
  189. package/scripts/forge-team/index.sh +86 -0
  190. package/scripts/forge-team/lib/agent-prompt.sh +52 -0
  191. package/scripts/forge-team/lib/claim.sh +256 -0
  192. package/scripts/forge-team/lib/dashboard.sh +341 -0
  193. package/scripts/forge-team/lib/epic.sh +332 -0
  194. package/scripts/forge-team/lib/hooks.sh +253 -0
  195. package/scripts/forge-team/lib/identity.sh +235 -0
  196. package/scripts/forge-team/lib/sync-github.sh +317 -0
  197. package/scripts/forge-team/lib/verify.sh +284 -0
  198. package/scripts/forge-team/lib/workload.sh +296 -0
  199. package/scripts/forge-team/tests/agent-prompt.test.sh +72 -0
  200. package/scripts/forge-team/tests/claim.test.sh +179 -0
  201. package/scripts/forge-team/tests/dashboard.test.sh +170 -0
  202. package/scripts/forge-team/tests/dispatcher.test.sh +79 -0
  203. package/scripts/forge-team/tests/epic.test.sh +176 -0
  204. package/scripts/forge-team/tests/hooks.test.sh +239 -0
  205. package/scripts/forge-team/tests/identity.test.sh +176 -0
  206. package/scripts/forge-team/tests/integration.test.sh +371 -0
  207. package/scripts/forge-team/tests/sync-github.test.sh +209 -0
  208. package/scripts/forge-team/tests/verify.test.sh +314 -0
  209. package/scripts/forge-team/tests/workflow-integration.test.sh +43 -0
  210. package/scripts/forge-team/tests/workload.test.sh +209 -0
  211. package/scripts/github-beads-sync/comment.mjs +64 -0
  212. package/scripts/github-beads-sync/config.mjs +148 -0
  213. package/scripts/github-beads-sync/github-api.mjs +131 -0
  214. package/scripts/github-beads-sync/index.mjs +332 -0
  215. package/scripts/github-beads-sync/label-mapper.mjs +54 -0
  216. package/scripts/github-beads-sync/mapping.mjs +78 -0
  217. package/scripts/github-beads-sync/reverse-sync-cli.mjs +31 -0
  218. package/scripts/github-beads-sync/reverse-sync.mjs +138 -0
  219. package/scripts/github-beads-sync/run-bd.mjs +159 -0
  220. package/scripts/github-beads-sync/sanitize.mjs +121 -0
  221. package/scripts/github-beads-sync.config.json +26 -0
  222. package/scripts/improve-command.js +375 -0
  223. package/scripts/lib/eval-runner.js +268 -0
  224. package/scripts/lib/eval-schema.js +135 -0
  225. package/scripts/lib/eval-storage.js +78 -0
  226. package/scripts/lib/grading.js +203 -0
  227. package/scripts/lib/jsonl-lock.sh +48 -0
  228. package/scripts/lib/sanitize.sh +116 -0
  229. package/scripts/lib/transcript-parser.js +63 -0
  230. package/scripts/lint.js +47 -0
  231. package/scripts/migrate-to-bun-test.js +412 -0
  232. package/scripts/pr-coordinator.sh +706 -0
  233. package/scripts/run-command-eval.js +236 -0
  234. package/scripts/smart-status.sh +809 -0
  235. package/scripts/sync-commands.js +571 -0
  236. package/scripts/sync-utils.sh +455 -0
  237. package/scripts/test-dashboard.js +123 -0
  238. package/scripts/test.js +46 -0
  239. package/scripts/validate.sh +94 -0
  240. package/skills/parallel-deep-research/SKILL.md +108 -108
  241. package/skills/parallel-deep-research/evals/README.md +27 -27
  242. package/skills/parallel-deep-research/evals/evals.json +62 -62
  243. package/skills/sonarcloud-analysis/SKILL.md +171 -171
  244. package/skills/sonarcloud-analysis/evals/README.md +27 -27
  245. package/skills/sonarcloud-analysis/evals/evals.json +50 -50
  246. package/skills/sonarcloud-analysis/references/api-reference.md +466 -466
  247. package/.cursor/hooks/state/continual-learning-index.json +0 -19
  248. package/.cursor/hooks/state/continual-learning.json +0 -8
package/lefthook.yml CHANGED
@@ -1,39 +1,50 @@
1
- # Lefthook Git Hooks Configuration
2
- # TDD Enforcement for Forge Workflow
3
- #
4
- # To skip hooks in emergencies:
5
- # git commit --no-verify (skip pre-commit)
6
- # LEFTHOOK=0 git push (skip pre-push)
7
-
8
- commit-msg:
9
- commands:
10
- commitlint:
11
- run: node scripts/commitlint.js {1}
12
- tags: commitlint
13
-
14
- pre-commit:
15
- commands:
16
- tdd-check:
17
- run: node .forge/hooks/check-tdd.js
18
- stage_fixed: false
19
- tags: tdd
20
- glob: "*.{js,ts,jsx,tsx,py,go,java,rb}"
21
-
22
- pre-push:
23
- commands:
24
- # 1. Block direct push to main/master (dual-layer protection)
25
- # Uses Node.js for cross-platform compatibility (Windows, macOS, Linux)
26
- branch-protection:
27
- run: node scripts/branch-protection.js
28
- tags: protection
29
-
30
- # 2. ESLint check (strict mode: blocks on errors and warnings)
31
- # Uses Node.js script for cross-platform compatibility
32
- lint:
33
- run: node scripts/lint.js
34
- tags: lint
35
-
36
- # 3. Test suite (cross-platform Node.js script detects package manager)
37
- tests:
38
- run: node scripts/test.js
39
- tags: tests
1
+ # Lefthook Git Hooks Configuration
2
+ # TDD Enforcement for Forge Workflow
3
+ #
4
+ # To skip hooks in emergencies:
5
+ # git commit --no-verify (skip pre-commit)
6
+ # LEFTHOOK=0 git push (skip pre-push)
7
+
8
+ commit-msg:
9
+ commands:
10
+ commitlint:
11
+ run: node scripts/commitlint.js {1}
12
+ tags: commitlint
13
+
14
+ pre-commit:
15
+ commands:
16
+ tdd-check:
17
+ run: node .forge/hooks/check-tdd.js
18
+ stage_fixed: false
19
+ tags: tdd
20
+ glob: "*.{js,ts,jsx,tsx,py,go,java,rb}"
21
+
22
+ pre-push:
23
+ commands:
24
+ # 1. Block direct push to main/master (dual-layer protection)
25
+ # Uses Node.js for cross-platform compatibility (Windows, macOS, Linux)
26
+ branch-protection:
27
+ run: node scripts/branch-protection.js
28
+ tags: protection
29
+ skip:
30
+ - run: node scripts/check-forge-token.js
31
+
32
+ # 2. ESLint check (strict mode: blocks on errors and warnings)
33
+ # Uses Node.js script for cross-platform compatibility
34
+ lint:
35
+ run: node scripts/lint.js
36
+ tags: lint
37
+ skip:
38
+ - run: node scripts/check-forge-token.js
39
+
40
+ # 3. Test suite (cross-platform Node.js script detects package manager)
41
+ tests:
42
+ run: node scripts/test.js
43
+ tags: tests
44
+ skip:
45
+ - run: node scripts/check-forge-token.js
46
+
47
+ # 4. Team sync — push Beads status to GitHub (non-blocking)
48
+ team-sync:
49
+ run: bash scripts/forge-team/lib/hooks.sh sync --quiet || true
50
+ tags: team
@@ -1,198 +1,198 @@
1
- # Agent Plugins
2
-
3
- This directory contains plugin definitions for all supported AI coding agents.
4
-
5
- ## Plugin Architecture
6
-
7
- Each agent is defined by a JSON file following the plugin schema. This allows:
8
- - **Discoverability**: New agents can be added without modifying core code
9
- - **Community contributions**: Anyone can add support for new agents
10
- - **Backwards compatibility**: Existing functionality remains unchanged
11
- - **Maintainability**: Agent configurations are separated from business logic
12
-
13
- ## Plugin Schema
14
-
15
- Each plugin file must follow this structure:
16
-
17
- ```json
18
- {
19
- "id": "agent-id", // REQUIRED: Unique identifier (lowercase, alphanumeric, hyphens)
20
- "name": "Agent Name", // REQUIRED: Human-readable name
21
- "version": "1.0.0", // REQUIRED: Semantic version (x.y.z)
22
- "description": "...", // OPTIONAL: Brief description
23
- "homepage": "https://...", // OPTIONAL: Agent's homepage URL
24
- "capabilities": { // OPTIONAL: Agent capabilities
25
- "commands": true, // Supports commands
26
- "skills": true, // Supports skills
27
- "hooks": false // Supports git hooks
28
- },
29
- "directories": { // REQUIRED: Directory structure (at least one)
30
- "commands": ".your-agent/commands",
31
- "rules": ".your-agent/rules",
32
- "skills": ".your-agent/skills/forge-workflow",
33
- "scripts": ".your-agent/scripts"
34
- },
35
- "files": { // OPTIONAL: Important file paths
36
- "rootConfig": "YOUR-AGENT.md",
37
- "skillDefinition": ".your-agent/skills/forge-workflow/SKILL.md"
38
- },
39
- "setup": { // OPTIONAL: Setup instructions
40
- "copyCommands": true,
41
- "copyRules": true,
42
- "createSkill": true,
43
- "customSetup": "agent-name",
44
- "needsConversion": false
45
- }
46
- }
47
- ```
48
-
49
- ### Required Fields
50
-
51
- - **id**: Unique identifier for the agent (must match filename without `.plugin.json`)
52
- - **name**: Display name shown to users
53
- - **version**: Semantic version number (major.minor.patch)
54
- - **directories**: Object with at least one directory path
55
-
56
- ### Optional Fields
57
-
58
- - **description**: Short description of the agent
59
- - **homepage**: URL to agent's official website
60
- - **capabilities**: Object defining what the agent supports
61
- - **files**: Important configuration file paths
62
- - **setup**: Installation and setup instructions
63
-
64
- ## Supported Agents
65
-
66
- Currently supported AI coding agents:
67
-
68
- | Agent | ID | Description |
69
- |-------|----|-----------|
70
- | Claude Code | `claude` | Anthropic's CLI agent |
71
- | Cursor | `cursor` | AI-first code editor |
72
- | Kilo Code | `kilocode` | VS Code extension |
73
- | GitHub Copilot | `copilot` | GitHub's AI assistant |
74
- | OpenCode | `opencode` | Open-source agent |
75
- | Cline | `cline` | VS Code agent extension |
76
- | Roo Code | `roo` | Cline fork with modes |
77
-
78
- ## Adding a New Agent
79
-
80
- To add support for a new AI coding agent:
81
-
82
- 1. **Create plugin file**: `lib/agents/your-agent.plugin.json`
83
- 2. **Follow schema**: Use the template below or copy an existing plugin
84
- 3. **Validate**: Run tests to ensure your plugin is valid
85
- 4. **Test**: Run `bunx forge setup --agents your-agent` to verify
86
- 5. **Submit PR**: Contribute back to the community!
87
-
88
- ### Plugin Template
89
-
90
- See `.github/PLUGIN_TEMPLATE.json` for a ready-to-use template.
91
-
92
- ```json
93
- {
94
- "id": "your-agent",
95
- "name": "Your Agent Name",
96
- "version": "1.0.0",
97
- "description": "Brief description of your agent",
98
- "homepage": "https://your-agent.example.com",
99
- "capabilities": {
100
- "commands": true,
101
- "skills": true,
102
- "hooks": false
103
- },
104
- "directories": {
105
- "rules": ".your-agent/rules",
106
- "skills": ".your-agent/skills/forge-workflow"
107
- },
108
- "files": {
109
- "rootConfig": ".your-agent-rules"
110
- },
111
- "setup": {
112
- "createSkill": true
113
- }
114
- }
115
- ```
116
-
117
- ## Validation
118
-
119
- The PluginManager automatically validates all plugins on load:
120
-
121
- - **Schema validation**: Required fields must be present
122
- - **Type checking**: Fields must have correct types
123
- - **Unique IDs**: No duplicate plugin IDs allowed
124
- - **JSON syntax**: Files must be valid JSON
125
-
126
- Run tests to validate your plugin:
127
-
128
- ```bash
129
- bun test test/plugins/
130
- ```
131
-
132
- ## Community Contributions
133
-
134
- We welcome community contributions for new AI coding agents!
135
-
136
- **Before submitting:**
137
- 1. Ensure your plugin passes all validation tests
138
- 2. Test the agent setup with `bunx forge setup --agents your-agent`
139
- 3. Document any special setup requirements
140
- 4. Follow the existing plugin structure
141
-
142
- **PR Guidelines:**
143
- - One plugin per PR
144
- - Include plugin JSON file only (no code changes needed)
145
- - Update this README with agent information
146
- - Test that all existing tests still pass
147
-
148
- ## Technical Details
149
-
150
- ### Plugin Loading
151
-
152
- The `PluginManager` class (`lib/plugin-manager.js`) handles:
153
- - Auto-discovery of `.plugin.json` files in this directory
154
- - Schema validation for each plugin
155
- - Conversion to internal AGENTS format (backwards compatibility)
156
- - Error handling for invalid plugins
157
-
158
- ### Backwards Compatibility
159
-
160
- Plugins are automatically converted to the legacy AGENTS object structure:
161
-
162
- ```javascript
163
- {
164
- name: plugin.name,
165
- description: plugin.description,
166
- dirs: Object.values(plugin.directories),
167
- hasCommands: plugin.capabilities?.commands,
168
- hasSkill: plugin.capabilities?.skills,
169
- // ... other fields
170
- }
171
- ```
172
-
173
- This ensures existing code continues to work without modifications.
174
-
175
- ## Troubleshooting
176
-
177
- ### Plugin Not Loading
178
-
179
- If your plugin isn't appearing in `bunx forge setup`:
180
-
181
- 1. **Check filename**: Must end with `.plugin.json`
182
- 2. **Validate JSON**: Ensure file is valid JSON (no trailing commas, quotes correct)
183
- 3. **Check required fields**: id, name, version, directories must be present
184
- 4. **Run tests**: `bun test test/plugins/` will show specific errors
185
- 5. **Check logs**: Any loading errors will be displayed
186
-
187
- ### Schema Validation Errors
188
-
189
- Common validation errors:
190
-
191
- - `missing required field "id"`: Add the id field
192
- - `"directories" must be an object`: Ensure directories is an object, not array
193
- - `"version" must be a string`: Version must be in "x.y.z" format
194
- - `Plugin with ID "x" already exists`: Choose a unique ID
195
-
196
- ## License
197
-
198
- All plugin definitions in this directory are MIT licensed, same as the Forge project.
1
+ # Agent Plugins
2
+
3
+ This directory contains plugin definitions for all supported AI coding agents.
4
+
5
+ ## Plugin Architecture
6
+
7
+ Each agent is defined by a JSON file following the plugin schema. This allows:
8
+ - **Discoverability**: New agents can be added without modifying core code
9
+ - **Community contributions**: Anyone can add support for new agents
10
+ - **Backwards compatibility**: Existing functionality remains unchanged
11
+ - **Maintainability**: Agent configurations are separated from business logic
12
+
13
+ ## Plugin Schema
14
+
15
+ Each plugin file must follow this structure:
16
+
17
+ ```json
18
+ {
19
+ "id": "agent-id", // REQUIRED: Unique identifier (lowercase, alphanumeric, hyphens)
20
+ "name": "Agent Name", // REQUIRED: Human-readable name
21
+ "version": "1.0.0", // REQUIRED: Semantic version (x.y.z)
22
+ "description": "...", // OPTIONAL: Brief description
23
+ "homepage": "https://...", // OPTIONAL: Agent's homepage URL
24
+ "capabilities": { // OPTIONAL: Agent capabilities
25
+ "commands": true, // Supports commands
26
+ "skills": true, // Supports skills
27
+ "hooks": false // Supports git hooks
28
+ },
29
+ "directories": { // REQUIRED: Directory structure (at least one)
30
+ "commands": ".your-agent/commands",
31
+ "rules": ".your-agent/rules",
32
+ "skills": ".your-agent/skills/forge-workflow",
33
+ "scripts": ".your-agent/scripts"
34
+ },
35
+ "files": { // OPTIONAL: Important file paths
36
+ "rootConfig": "YOUR-AGENT.md",
37
+ "skillDefinition": ".your-agent/skills/forge-workflow/SKILL.md"
38
+ },
39
+ "setup": { // OPTIONAL: Setup instructions
40
+ "copyCommands": true,
41
+ "copyRules": true,
42
+ "createSkill": true,
43
+ "customSetup": "agent-name",
44
+ "needsConversion": false
45
+ }
46
+ }
47
+ ```
48
+
49
+ ### Required Fields
50
+
51
+ - **id**: Unique identifier for the agent (must match filename without `.plugin.json`)
52
+ - **name**: Display name shown to users
53
+ - **version**: Semantic version number (major.minor.patch)
54
+ - **directories**: Object with at least one directory path
55
+
56
+ ### Optional Fields
57
+
58
+ - **description**: Short description of the agent
59
+ - **homepage**: URL to agent's official website
60
+ - **capabilities**: Object defining what the agent supports
61
+ - **files**: Important configuration file paths
62
+ - **setup**: Installation and setup instructions
63
+
64
+ ## Supported Agents
65
+
66
+ Currently supported AI coding agents:
67
+
68
+ | Agent | ID | Description |
69
+ |-------|----|-----------|
70
+ | Claude Code | `claude` | Anthropic's CLI agent |
71
+ | Cursor | `cursor` | AI-first code editor |
72
+ | Kilo Code | `kilocode` | VS Code extension |
73
+ | GitHub Copilot | `copilot` | GitHub's AI assistant |
74
+ | OpenCode | `opencode` | Open-source agent |
75
+ | Cline | `cline` | VS Code agent extension |
76
+ | Roo Code | `roo` | Cline fork with modes |
77
+
78
+ ## Adding a New Agent
79
+
80
+ To add support for a new AI coding agent:
81
+
82
+ 1. **Create plugin file**: `lib/agents/your-agent.plugin.json`
83
+ 2. **Follow schema**: Use the template below or copy an existing plugin
84
+ 3. **Validate**: Run tests to ensure your plugin is valid
85
+ 4. **Test**: Run `bunx forge setup --agents your-agent` to verify
86
+ 5. **Submit PR**: Contribute back to the community!
87
+
88
+ ### Plugin Template
89
+
90
+ See `.github/PLUGIN_TEMPLATE.json` for a ready-to-use template.
91
+
92
+ ```json
93
+ {
94
+ "id": "your-agent",
95
+ "name": "Your Agent Name",
96
+ "version": "1.0.0",
97
+ "description": "Brief description of your agent",
98
+ "homepage": "https://your-agent.example.com",
99
+ "capabilities": {
100
+ "commands": true,
101
+ "skills": true,
102
+ "hooks": false
103
+ },
104
+ "directories": {
105
+ "rules": ".your-agent/rules",
106
+ "skills": ".your-agent/skills/forge-workflow"
107
+ },
108
+ "files": {
109
+ "rootConfig": ".your-agent-rules"
110
+ },
111
+ "setup": {
112
+ "createSkill": true
113
+ }
114
+ }
115
+ ```
116
+
117
+ ## Validation
118
+
119
+ The PluginManager automatically validates all plugins on load:
120
+
121
+ - **Schema validation**: Required fields must be present
122
+ - **Type checking**: Fields must have correct types
123
+ - **Unique IDs**: No duplicate plugin IDs allowed
124
+ - **JSON syntax**: Files must be valid JSON
125
+
126
+ Run tests to validate your plugin:
127
+
128
+ ```bash
129
+ bun test test/plugins/
130
+ ```
131
+
132
+ ## Community Contributions
133
+
134
+ We welcome community contributions for new AI coding agents!
135
+
136
+ **Before submitting:**
137
+ 1. Ensure your plugin passes all validation tests
138
+ 2. Test the agent setup with `bunx forge setup --agents your-agent`
139
+ 3. Document any special setup requirements
140
+ 4. Follow the existing plugin structure
141
+
142
+ **PR Guidelines:**
143
+ - One plugin per PR
144
+ - Include plugin JSON file only (no code changes needed)
145
+ - Update this README with agent information
146
+ - Test that all existing tests still pass
147
+
148
+ ## Technical Details
149
+
150
+ ### Plugin Loading
151
+
152
+ The `PluginManager` class (`lib/plugin-manager.js`) handles:
153
+ - Auto-discovery of `.plugin.json` files in this directory
154
+ - Schema validation for each plugin
155
+ - Conversion to internal AGENTS format (backwards compatibility)
156
+ - Error handling for invalid plugins
157
+
158
+ ### Backwards Compatibility
159
+
160
+ Plugins are automatically converted to the legacy AGENTS object structure:
161
+
162
+ ```javascript
163
+ {
164
+ name: plugin.name,
165
+ description: plugin.description,
166
+ dirs: Object.values(plugin.directories),
167
+ hasCommands: plugin.capabilities?.commands,
168
+ hasSkill: plugin.capabilities?.skills,
169
+ // ... other fields
170
+ }
171
+ ```
172
+
173
+ This ensures existing code continues to work without modifications.
174
+
175
+ ## Troubleshooting
176
+
177
+ ### Plugin Not Loading
178
+
179
+ If your plugin isn't appearing in `bunx forge setup`:
180
+
181
+ 1. **Check filename**: Must end with `.plugin.json`
182
+ 2. **Validate JSON**: Ensure file is valid JSON (no trailing commas, quotes correct)
183
+ 3. **Check required fields**: id, name, version, directories must be present
184
+ 4. **Run tests**: `bun test test/plugins/` will show specific errors
185
+ 5. **Check logs**: Any loading errors will be displayed
186
+
187
+ ### Schema Validation Errors
188
+
189
+ Common validation errors:
190
+
191
+ - `missing required field "id"`: Add the id field
192
+ - `"directories" must be an object`: Ensure directories is an object, not array
193
+ - `"version" must be a string`: Version must be in "x.y.z" format
194
+ - `Plugin with ID "x" already exists`: Choose a unique ID
195
+
196
+ ## License
197
+
198
+ All plugin definitions in this directory are MIT licensed, same as the Forge project.
@@ -1,28 +1,28 @@
1
- {
2
- "id": "claude",
3
- "name": "Claude Code",
4
- "version": "1.0.0",
5
- "description": "Anthropic's CLI agent",
6
- "homepage": "https://claude.ai/code",
7
- "capabilities": {
8
- "commands": true,
9
- "skills": true,
10
- "hooks": true
11
- },
12
- "directories": {
13
- "commands": ".claude/commands",
14
- "rules": ".claude/rules",
15
- "skills": ".claude/skills/forge-workflow",
16
- "scripts": ".claude/scripts"
17
- },
18
- "files": {
19
- "rootConfig": "CLAUDE.md",
20
- "skillDefinition": ".claude/skills/forge-workflow/SKILL.md"
21
- },
22
- "setup": {
23
- "copyCommands": true,
24
- "copyRules": true,
25
- "copyScripts": true,
26
- "createSkill": true
27
- }
28
- }
1
+ {
2
+ "id": "claude",
3
+ "name": "Claude Code",
4
+ "version": "1.0.0",
5
+ "description": "Anthropic's CLI agent",
6
+ "homepage": "https://claude.ai/code",
7
+ "capabilities": {
8
+ "commands": true,
9
+ "skills": true,
10
+ "hooks": true
11
+ },
12
+ "directories": {
13
+ "commands": ".claude/commands",
14
+ "rules": ".claude/rules",
15
+ "skills": ".claude/skills/forge-workflow",
16
+ "scripts": ".claude/scripts"
17
+ },
18
+ "files": {
19
+ "rootConfig": "CLAUDE.md",
20
+ "skillDefinition": ".claude/skills/forge-workflow/SKILL.md"
21
+ },
22
+ "setup": {
23
+ "copyCommands": true,
24
+ "copyRules": true,
25
+ "copyScripts": true,
26
+ "createSkill": true
27
+ }
28
+ }
@@ -1,22 +1,22 @@
1
- {
2
- "id": "cline",
3
- "name": "Cline",
4
- "version": "1.0.0",
5
- "description": "VS Code agent extension",
6
- "homepage": "https://github.com/cline/cline",
7
- "capabilities": {
8
- "commands": true,
9
- "skills": true,
10
- "hooks": false
11
- },
12
- "directories": {
13
- "workflows": ".cline/workflows",
14
- "skills": ".cline/skills/forge-workflow"
15
- },
16
- "files": {
17
- "rootConfig": ".clinerules"
18
- },
19
- "setup": {
20
- "createSkill": true
21
- }
22
- }
1
+ {
2
+ "id": "cline",
3
+ "name": "Cline",
4
+ "version": "1.0.0",
5
+ "description": "VS Code agent extension",
6
+ "homepage": "https://github.com/cline/cline",
7
+ "capabilities": {
8
+ "commands": true,
9
+ "skills": true,
10
+ "hooks": false
11
+ },
12
+ "directories": {
13
+ "workflows": ".cline/workflows",
14
+ "skills": ".cline/skills/forge-workflow"
15
+ },
16
+ "files": {
17
+ "rootConfig": ".clinerules"
18
+ },
19
+ "setup": {
20
+ "createSkill": true
21
+ }
22
+ }
@@ -1,19 +1,19 @@
1
- {
2
- "id": "codex",
3
- "name": "OpenAI Codex CLI",
4
- "version": "1.0.0",
5
- "description": "OpenAI's terminal coding agent",
6
- "homepage": "https://github.com/openai/codex",
7
- "capabilities": {
8
- "commands": true,
9
- "skills": false,
10
- "hooks": false
11
- },
12
- "directories": {
13
- "skills": ".codex/skills"
14
- },
15
- "setup": {
16
- "copyRules": false,
17
- "createSkill": false
18
- }
19
- }
1
+ {
2
+ "id": "codex",
3
+ "name": "OpenAI Codex CLI",
4
+ "version": "1.0.0",
5
+ "description": "OpenAI's terminal coding agent",
6
+ "homepage": "https://github.com/openai/codex",
7
+ "capabilities": {
8
+ "commands": true,
9
+ "skills": false,
10
+ "hooks": false
11
+ },
12
+ "directories": {
13
+ "skills": ".codex/skills"
14
+ },
15
+ "setup": {
16
+ "copyRules": false,
17
+ "createSkill": false
18
+ }
19
+ }