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
@@ -1,466 +1,466 @@
1
- # SonarCloud API Reference
2
-
3
- Complete parameter and response documentation for all endpoints.
4
-
5
- ## Issues (`/api/issues/search`)
6
-
7
- ### Parameters
8
-
9
- | Parameter | Description | Values |
10
- | --------- | ----------- | ------ |
11
- | `organization` | Org key | Required |
12
- | `componentKeys` | Project key(s) | Comma-separated |
13
- | `types` | Issue types | `BUG`, `VULNERABILITY`, `CODE_SMELL`, `SECURITY_HOTSPOT` |
14
- | `severities` | Severity | `BLOCKER`, `CRITICAL`, `MAJOR`, `MINOR`, `INFO` |
15
- | `statuses` | Status | `OPEN`, `CONFIRMED`, `REOPENED`, `RESOLVED`, `CLOSED` |
16
- | `resolutions` | Resolution | `FALSE-POSITIVE`, `WONTFIX`, `FIXED`, `REMOVED` |
17
- | `resolved` | Filter | `true`, `false` |
18
- | `branch` | Branch name | String |
19
- | `pullRequest` | PR number | String |
20
- | `createdAfter` | Date filter | `YYYY-MM-DD` |
21
- | `createdBefore` | Date filter | `YYYY-MM-DD` |
22
- | `languages` | Languages | `java`, `typescript`, `python`, etc. |
23
- | `rules` | Rule keys | Comma-separated |
24
- | `tags` | Issue tags | Comma-separated |
25
- | `assignees` | Assigned users | Comma-separated |
26
- | `authors` | Code authors | Comma-separated |
27
- | `scopes` | Scope | `MAIN`, `TEST` |
28
- | `inNewCodePeriod` | New code only | `true`, `false` |
29
- | `facets` | Aggregations | `severities`, `types`, `rules`, `tags` |
30
- | `p` | Page number | Integer (1-based) |
31
- | `ps` | Page size | Integer (max 500) |
32
- | `s` | Sort field | `CREATION_DATE`, `UPDATE_DATE`, `SEVERITY` |
33
- | `asc` | Sort order | `true`, `false` |
34
-
35
- ### Response
36
-
37
- ```json
38
- {
39
- "total": 150,
40
- "paging": { "pageIndex": 1, "pageSize": 100, "total": 150 },
41
- "issues": [{
42
- "key": "AYx...",
43
- "rule": "typescript:S1234",
44
- "severity": "MAJOR",
45
- "component": "my-project:src/file.ts",
46
- "line": 42,
47
- "message": "Remove this unused variable.",
48
- "type": "CODE_SMELL",
49
- "status": "OPEN",
50
- "effort": "5min",
51
- "tags": ["unused"],
52
- "creationDate": "2024-01-15T10:30:00+0000"
53
- }],
54
- "facets": [{ "property": "severities", "values": [{ "val": "MAJOR", "count": 50 }] }]
55
- }
56
- ```
57
-
58
- ---
59
-
60
- ## Metrics (`/api/measures/component`)
61
-
62
- ### Parameters
63
-
64
- | Parameter | Description |
65
- | --------- | ----------- |
66
- | `component` | Project key (required) |
67
- | `metricKeys` | Metrics (comma-separated) |
68
- | `branch` | Branch name |
69
- | `pullRequest` | PR number |
70
- | `additionalFields` | `metrics`, `periods` |
71
-
72
- ### All Metric Keys
73
-
74
- | Category | Keys |
75
- | -------- | ---- |
76
- | Size | `ncloc`, `lines`, `statements`, `functions`, `classes`, `files` |
77
- | Complexity | `complexity`, `cognitive_complexity` |
78
- | Coverage | `coverage`, `line_coverage`, `branch_coverage`, `tests`, `test_success_density`, `uncovered_lines`, `uncovered_conditions` |
79
- | Duplication | `duplicated_lines`, `duplicated_lines_density`, `duplicated_blocks`, `duplicated_files` |
80
- | Issues | `bugs`, `vulnerabilities`, `code_smells`, `security_hotspots` |
81
- | Ratings | `sqale_rating`, `reliability_rating`, `security_rating`, `security_review_rating` (1=A to 5=E) |
82
- | Debt | `sqale_index` (minutes), `sqale_debt_ratio` (%) |
83
- | Quality Gate | `alert_status`, `quality_gate_details` |
84
- | New Code | `new_bugs`, `new_vulnerabilities`, `new_code_smells`, `new_coverage`, `new_duplicated_lines_density` |
85
-
86
- ### Response
87
-
88
- ```json
89
- {
90
- "component": {
91
- "key": "my-project",
92
- "name": "My Project",
93
- "measures": [
94
- { "metric": "bugs", "value": "12" },
95
- { "metric": "coverage", "value": "78.5" },
96
- { "metric": "sqale_rating", "value": "2.0" }
97
- ]
98
- }
99
- }
100
- ```
101
-
102
- ---
103
-
104
- ## Quality Gate (`/api/qualitygates/project_status`)
105
-
106
- ### Parameters
107
-
108
- | Parameter | Description |
109
- | --------- | ----------- |
110
- | `projectKey` | Project key (required) |
111
- | `branch` | Branch name |
112
- | `pullRequest` | PR number |
113
-
114
- ### Response
115
-
116
- ```json
117
- {
118
- "projectStatus": {
119
- "status": "ERROR",
120
- "conditions": [{
121
- "status": "ERROR",
122
- "metricKey": "new_coverage",
123
- "comparator": "LT",
124
- "errorThreshold": "80",
125
- "actualValue": "65.3"
126
- }],
127
- "ignoredConditions": false
128
- }
129
- }
130
- ```
131
-
132
- ---
133
-
134
- ## Security Hotspots (`/api/hotspots/search`)
135
-
136
- ### Parameters
137
-
138
- | Parameter | Description | Values |
139
- | --------- | ----------- | ------ |
140
- | `projectKey` | Project key | Required |
141
- | `branch` | Branch name | String |
142
- | `pullRequest` | PR number | String |
143
- | `status` | Status | `TO_REVIEW`, `REVIEWED` |
144
- | `resolution` | Resolution | `FIXED`, `SAFE`, `ACKNOWLEDGED` |
145
- | `inNewCodePeriod` | New code | `true`, `false` |
146
- | `p` / `ps` | Pagination | Integer |
147
-
148
- ### Response
149
-
150
- ```json
151
- {
152
- "paging": { "total": 5 },
153
- "hotspots": [{
154
- "key": "...",
155
- "component": "my-project:src/auth.ts",
156
- "securityCategory": "sql-injection",
157
- "vulnerabilityProbability": "HIGH",
158
- "status": "TO_REVIEW",
159
- "message": "Make sure this SQL query is safe.",
160
- "line": 42
161
- }]
162
- }
163
- ```
164
-
165
- ---
166
-
167
- ## Projects (`/api/projects/search`)
168
-
169
- ### Parameters
170
-
171
- | Parameter | Description |
172
- | --------- | ----------- |
173
- | `organization` | Org key |
174
- | `q` | Search query |
175
- | `qualifiers` | `TRK` (project), `APP` |
176
- | `p` / `ps` | Pagination |
177
-
178
- ---
179
-
180
- ## Analysis History (`/api/project_analyses/search`)
181
-
182
- ### Parameters
183
-
184
- | Parameter | Description |
185
- | --------- | ----------- |
186
- | `project` | Project key |
187
- | `branch` | Branch name |
188
- | `from` / `to` | Date range |
189
- | `p` / `ps` | Pagination |
190
-
191
- ### Response
192
-
193
- ```json
194
- {
195
- "analyses": [{
196
- "key": "AYx...",
197
- "date": "2024-01-15T10:30:00+0000",
198
- "projectVersion": "1.2.0",
199
- "revision": "abc123def",
200
- "events": [{ "category": "VERSION", "name": "1.2.0" }]
201
- }]
202
- }
203
- ```
204
-
205
- ---
206
-
207
- ## Metrics History (`/api/measures/search_history`)
208
-
209
- ### Parameters
210
-
211
- | Parameter | Description |
212
- | --------- | ----------- |
213
- | `component` | Project key |
214
- | `metrics` | Metric keys |
215
- | `from` / `to` | Date range (`YYYY-MM-DD`) |
216
- | `branch` | Branch name |
217
- | `p` / `ps` | Pagination |
218
-
219
- ---
220
-
221
- ## Component Tree (`/api/components/tree`)
222
-
223
- ### Parameters
224
-
225
- | Parameter | Description |
226
- | --------- | ----------- |
227
- | `component` | Project key |
228
- | `branch` | Branch name |
229
- | `qualifiers` | `FIL` (file), `DIR`, `UTS` (test) |
230
- | `metricKeys` | Metrics per component |
231
- | `strategy` | `children`, `leaves`, `all` |
232
- | `q` | Search query |
233
- | `s` / `asc` | Sort field / ascending |
234
- | `metricSort` | Metric to sort by |
235
-
236
- ---
237
-
238
- ## Duplications (`/api/duplications/show`)
239
-
240
- Get detailed duplicate code blocks for a specific file.
241
-
242
- ### Parameters
243
-
244
- | Parameter | Description |
245
- | --------- | ----------- |
246
- | `key` | File key (required) - format: `project-key:path/to/file.ts` |
247
- | `branch` | Branch name |
248
- | `pullRequest` | PR number |
249
-
250
- ### Response
251
-
252
- ```json
253
- {
254
- "duplications": [
255
- {
256
- "blocks": [
257
- {
258
- "from": 1,
259
- "size": 20,
260
- "_ref": "1"
261
- },
262
- {
263
- "from": 50,
264
- "size": 20,
265
- "_ref": "2"
266
- }
267
- ]
268
- }
269
- ],
270
- "files": {
271
- "1": {
272
- "key": "my-project:src/utils/helpers.ts",
273
- "name": "helpers.ts",
274
- "projectName": "My Project"
275
- },
276
- "2": {
277
- "key": "my-project:src/utils/common.ts",
278
- "name": "common.ts",
279
- "projectName": "My Project"
280
- }
281
- }
282
- }
283
- ```
284
-
285
- ### Workflow: Find All Duplicates
286
-
287
- ```bash
288
- # 1. Get files with most duplication
289
- curl -H "Authorization: Bearer $TOKEN" \
290
- "https://sonarcloud.io/api/components/tree?component=$PROJECT&qualifiers=FIL&metricKeys=duplicated_lines_density&s=metric&metricSort=duplicated_lines_density&asc=false&ps=20"
291
-
292
- # 2. For each file, get duplicate blocks
293
- curl -H "Authorization: Bearer $TOKEN" \
294
- "https://sonarcloud.io/api/duplications/show?key=my-project:src/file.ts"
295
- ```
296
-
297
- ---
298
-
299
- ## Rules (`/api/rules/search`)
300
-
301
- ### Parameters
302
-
303
- | Parameter | Description |
304
- | --------- | ----------- |
305
- | `languages` | Filter by language |
306
- | `severities` | Filter by severity |
307
- | `types` | Filter by type |
308
- | `tags` | Filter by tags |
309
- | `q` | Search query |
310
- | `p` / `ps` | Pagination |
311
-
312
- ---
313
-
314
- ## Sources (`/api/sources/*`)
315
-
316
- ### Raw Source Code (`/api/sources/raw`)
317
-
318
- | Parameter | Description |
319
- | --------- | ----------- |
320
- | `key` | File key (required) - format: `project:path/to/file.ts` |
321
- | `branch` | Branch name |
322
-
323
- ```bash
324
- curl -H "Authorization: Bearer $TOKEN" \
325
- "https://sonarcloud.io/api/sources/raw?key=my-project:src/utils/helpers.ts"
326
- ```
327
-
328
- ### SCM Blame (`/api/sources/scm`)
329
-
330
- | Parameter | Description |
331
- | --------- | ----------- |
332
- | `key` | File key (required) |
333
- | `from` | Start line |
334
- | `to` | End line |
335
-
336
- ```bash
337
- curl -H "Authorization: Bearer $TOKEN" \
338
- "https://sonarcloud.io/api/sources/scm?key=my-project:src/utils/helpers.ts"
339
- ```
340
-
341
- **Response**: Returns author, date, and revision for each line.
342
-
343
- ---
344
-
345
- ## Compute Engine (`/api/ce/activity`)
346
-
347
- Get background task status (analysis jobs).
348
-
349
- | Parameter | Description |
350
- | --------- | ----------- |
351
- | `component` | Project key |
352
- | `status` | `SUCCESS`, `FAILED`, `CANCELED`, `PENDING`, `IN_PROGRESS` |
353
- | `type` | Task type (e.g., `REPORT`) |
354
- | `minSubmittedAt` | Filter by submission date |
355
- | `maxExecutedAt` | Filter by execution date |
356
- | `p` / `ps` | Pagination |
357
-
358
- ```bash
359
- curl -H "Authorization: Bearer $TOKEN" \
360
- "https://sonarcloud.io/api/ce/activity?component=my-project&status=FAILED"
361
- ```
362
-
363
- ---
364
-
365
- ## Quality Profiles (`/api/qualityprofiles/search`)
366
-
367
- | Parameter | Description |
368
- | --------- | ----------- |
369
- | `language` | Filter by language |
370
- | `project` | Project key |
371
- | `qualityProfile` | Profile name |
372
-
373
- ```bash
374
- curl -H "Authorization: Bearer $TOKEN" \
375
- "https://sonarcloud.io/api/qualityprofiles/search?language=ts"
376
- ```
377
-
378
- ---
379
-
380
- ## Languages (`/api/languages/list`)
381
-
382
- List all supported languages.
383
-
384
- ```bash
385
- curl -H "Authorization: Bearer $TOKEN" \
386
- "https://sonarcloud.io/api/languages/list"
387
- ```
388
-
389
- **Response**: `{ "languages": [{ "key": "ts", "name": "TypeScript" }, ...] }`
390
-
391
- ---
392
-
393
- ## Branches (`/api/project_branches/list`)
394
-
395
- | Parameter | Description |
396
- | --------- | ----------- |
397
- | `project` | Project key (required) |
398
-
399
- ```bash
400
- curl -H "Authorization: Bearer $TOKEN" \
401
- "https://sonarcloud.io/api/project_branches/list?project=my-project"
402
- ```
403
-
404
- **Response**: `{ "branches": [{ "name": "main", "isMain": true, "type": "LONG", "status": { "qualityGateStatus": "OK" } }] }`
405
-
406
- ---
407
-
408
- ## Badges (`/api/project_badges/*`)
409
-
410
- ### Measure Badge (`/api/project_badges/measure`)
411
-
412
- | Parameter | Description |
413
- | --------- | ----------- |
414
- | `project` | Project key |
415
- | `metric` | `bugs`, `coverage`, `code_smells`, `vulnerabilities`, etc. |
416
- | `branch` | Branch name |
417
-
418
- Returns SVG badge image.
419
-
420
- ```bash
421
- curl "https://sonarcloud.io/api/project_badges/measure?project=my-project&metric=coverage"
422
- ```
423
-
424
- ### Quality Gate Badge (`/api/project_badges/quality_gate`)
425
-
426
- | Parameter | Description |
427
- | --------- | ----------- |
428
- | `project` | Project key |
429
- | `branch` | Branch name |
430
-
431
- ```bash
432
- curl "https://sonarcloud.io/api/project_badges/quality_gate?project=my-project"
433
- ```
434
-
435
- ---
436
-
437
- ## Pagination Example
438
-
439
- ```bash
440
- PAGE=1
441
- while true; do
442
- R=$(curl -s -H "Authorization: Bearer $TOKEN" \
443
- "https://sonarcloud.io/api/issues/search?organization=$ORG&componentKeys=$PROJECT&p=$PAGE&ps=500")
444
- echo $R | jq '.issues[]'
445
- [ $((PAGE * 500)) -ge $(echo $R | jq '.total') ] && break
446
- PAGE=$((PAGE + 1))
447
- done
448
- ```
449
-
450
- ---
451
-
452
- ## Error Codes
453
-
454
- | Code | Meaning | Fix |
455
- | ---- | ------- | --- |
456
- | 401 | Invalid token | Check `SONARCLOUD_TOKEN` |
457
- | 403 | No permission | Verify project access |
458
- | 404 | Not found | Check project/org key |
459
- | 400 | Bad request | Check parameter values |
460
-
461
- ---
462
-
463
- ## References
464
-
465
- - [SonarCloud Web API](https://sonarcloud.io/web_api)
466
- - [SonarCloud Docs](https://docs.sonarsource.com/sonarcloud/)
1
+ # SonarCloud API Reference
2
+
3
+ Complete parameter and response documentation for all endpoints.
4
+
5
+ ## Issues (`/api/issues/search`)
6
+
7
+ ### Parameters
8
+
9
+ | Parameter | Description | Values |
10
+ | --------- | ----------- | ------ |
11
+ | `organization` | Org key | Required |
12
+ | `componentKeys` | Project key(s) | Comma-separated |
13
+ | `types` | Issue types | `BUG`, `VULNERABILITY`, `CODE_SMELL`, `SECURITY_HOTSPOT` |
14
+ | `severities` | Severity | `BLOCKER`, `CRITICAL`, `MAJOR`, `MINOR`, `INFO` |
15
+ | `statuses` | Status | `OPEN`, `CONFIRMED`, `REOPENED`, `RESOLVED`, `CLOSED` |
16
+ | `resolutions` | Resolution | `FALSE-POSITIVE`, `WONTFIX`, `FIXED`, `REMOVED` |
17
+ | `resolved` | Filter | `true`, `false` |
18
+ | `branch` | Branch name | String |
19
+ | `pullRequest` | PR number | String |
20
+ | `createdAfter` | Date filter | `YYYY-MM-DD` |
21
+ | `createdBefore` | Date filter | `YYYY-MM-DD` |
22
+ | `languages` | Languages | `java`, `typescript`, `python`, etc. |
23
+ | `rules` | Rule keys | Comma-separated |
24
+ | `tags` | Issue tags | Comma-separated |
25
+ | `assignees` | Assigned users | Comma-separated |
26
+ | `authors` | Code authors | Comma-separated |
27
+ | `scopes` | Scope | `MAIN`, `TEST` |
28
+ | `inNewCodePeriod` | New code only | `true`, `false` |
29
+ | `facets` | Aggregations | `severities`, `types`, `rules`, `tags` |
30
+ | `p` | Page number | Integer (1-based) |
31
+ | `ps` | Page size | Integer (max 500) |
32
+ | `s` | Sort field | `CREATION_DATE`, `UPDATE_DATE`, `SEVERITY` |
33
+ | `asc` | Sort order | `true`, `false` |
34
+
35
+ ### Response
36
+
37
+ ```json
38
+ {
39
+ "total": 150,
40
+ "paging": { "pageIndex": 1, "pageSize": 100, "total": 150 },
41
+ "issues": [{
42
+ "key": "AYx...",
43
+ "rule": "typescript:S1234",
44
+ "severity": "MAJOR",
45
+ "component": "my-project:src/file.ts",
46
+ "line": 42,
47
+ "message": "Remove this unused variable.",
48
+ "type": "CODE_SMELL",
49
+ "status": "OPEN",
50
+ "effort": "5min",
51
+ "tags": ["unused"],
52
+ "creationDate": "2024-01-15T10:30:00+0000"
53
+ }],
54
+ "facets": [{ "property": "severities", "values": [{ "val": "MAJOR", "count": 50 }] }]
55
+ }
56
+ ```
57
+
58
+ ---
59
+
60
+ ## Metrics (`/api/measures/component`)
61
+
62
+ ### Parameters
63
+
64
+ | Parameter | Description |
65
+ | --------- | ----------- |
66
+ | `component` | Project key (required) |
67
+ | `metricKeys` | Metrics (comma-separated) |
68
+ | `branch` | Branch name |
69
+ | `pullRequest` | PR number |
70
+ | `additionalFields` | `metrics`, `periods` |
71
+
72
+ ### All Metric Keys
73
+
74
+ | Category | Keys |
75
+ | -------- | ---- |
76
+ | Size | `ncloc`, `lines`, `statements`, `functions`, `classes`, `files` |
77
+ | Complexity | `complexity`, `cognitive_complexity` |
78
+ | Coverage | `coverage`, `line_coverage`, `branch_coverage`, `tests`, `test_success_density`, `uncovered_lines`, `uncovered_conditions` |
79
+ | Duplication | `duplicated_lines`, `duplicated_lines_density`, `duplicated_blocks`, `duplicated_files` |
80
+ | Issues | `bugs`, `vulnerabilities`, `code_smells`, `security_hotspots` |
81
+ | Ratings | `sqale_rating`, `reliability_rating`, `security_rating`, `security_review_rating` (1=A to 5=E) |
82
+ | Debt | `sqale_index` (minutes), `sqale_debt_ratio` (%) |
83
+ | Quality Gate | `alert_status`, `quality_gate_details` |
84
+ | New Code | `new_bugs`, `new_vulnerabilities`, `new_code_smells`, `new_coverage`, `new_duplicated_lines_density` |
85
+
86
+ ### Response
87
+
88
+ ```json
89
+ {
90
+ "component": {
91
+ "key": "my-project",
92
+ "name": "My Project",
93
+ "measures": [
94
+ { "metric": "bugs", "value": "12" },
95
+ { "metric": "coverage", "value": "78.5" },
96
+ { "metric": "sqale_rating", "value": "2.0" }
97
+ ]
98
+ }
99
+ }
100
+ ```
101
+
102
+ ---
103
+
104
+ ## Quality Gate (`/api/qualitygates/project_status`)
105
+
106
+ ### Parameters
107
+
108
+ | Parameter | Description |
109
+ | --------- | ----------- |
110
+ | `projectKey` | Project key (required) |
111
+ | `branch` | Branch name |
112
+ | `pullRequest` | PR number |
113
+
114
+ ### Response
115
+
116
+ ```json
117
+ {
118
+ "projectStatus": {
119
+ "status": "ERROR",
120
+ "conditions": [{
121
+ "status": "ERROR",
122
+ "metricKey": "new_coverage",
123
+ "comparator": "LT",
124
+ "errorThreshold": "80",
125
+ "actualValue": "65.3"
126
+ }],
127
+ "ignoredConditions": false
128
+ }
129
+ }
130
+ ```
131
+
132
+ ---
133
+
134
+ ## Security Hotspots (`/api/hotspots/search`)
135
+
136
+ ### Parameters
137
+
138
+ | Parameter | Description | Values |
139
+ | --------- | ----------- | ------ |
140
+ | `projectKey` | Project key | Required |
141
+ | `branch` | Branch name | String |
142
+ | `pullRequest` | PR number | String |
143
+ | `status` | Status | `TO_REVIEW`, `REVIEWED` |
144
+ | `resolution` | Resolution | `FIXED`, `SAFE`, `ACKNOWLEDGED` |
145
+ | `inNewCodePeriod` | New code | `true`, `false` |
146
+ | `p` / `ps` | Pagination | Integer |
147
+
148
+ ### Response
149
+
150
+ ```json
151
+ {
152
+ "paging": { "total": 5 },
153
+ "hotspots": [{
154
+ "key": "...",
155
+ "component": "my-project:src/auth.ts",
156
+ "securityCategory": "sql-injection",
157
+ "vulnerabilityProbability": "HIGH",
158
+ "status": "TO_REVIEW",
159
+ "message": "Make sure this SQL query is safe.",
160
+ "line": 42
161
+ }]
162
+ }
163
+ ```
164
+
165
+ ---
166
+
167
+ ## Projects (`/api/projects/search`)
168
+
169
+ ### Parameters
170
+
171
+ | Parameter | Description |
172
+ | --------- | ----------- |
173
+ | `organization` | Org key |
174
+ | `q` | Search query |
175
+ | `qualifiers` | `TRK` (project), `APP` |
176
+ | `p` / `ps` | Pagination |
177
+
178
+ ---
179
+
180
+ ## Analysis History (`/api/project_analyses/search`)
181
+
182
+ ### Parameters
183
+
184
+ | Parameter | Description |
185
+ | --------- | ----------- |
186
+ | `project` | Project key |
187
+ | `branch` | Branch name |
188
+ | `from` / `to` | Date range |
189
+ | `p` / `ps` | Pagination |
190
+
191
+ ### Response
192
+
193
+ ```json
194
+ {
195
+ "analyses": [{
196
+ "key": "AYx...",
197
+ "date": "2024-01-15T10:30:00+0000",
198
+ "projectVersion": "1.2.0",
199
+ "revision": "abc123def",
200
+ "events": [{ "category": "VERSION", "name": "1.2.0" }]
201
+ }]
202
+ }
203
+ ```
204
+
205
+ ---
206
+
207
+ ## Metrics History (`/api/measures/search_history`)
208
+
209
+ ### Parameters
210
+
211
+ | Parameter | Description |
212
+ | --------- | ----------- |
213
+ | `component` | Project key |
214
+ | `metrics` | Metric keys |
215
+ | `from` / `to` | Date range (`YYYY-MM-DD`) |
216
+ | `branch` | Branch name |
217
+ | `p` / `ps` | Pagination |
218
+
219
+ ---
220
+
221
+ ## Component Tree (`/api/components/tree`)
222
+
223
+ ### Parameters
224
+
225
+ | Parameter | Description |
226
+ | --------- | ----------- |
227
+ | `component` | Project key |
228
+ | `branch` | Branch name |
229
+ | `qualifiers` | `FIL` (file), `DIR`, `UTS` (test) |
230
+ | `metricKeys` | Metrics per component |
231
+ | `strategy` | `children`, `leaves`, `all` |
232
+ | `q` | Search query |
233
+ | `s` / `asc` | Sort field / ascending |
234
+ | `metricSort` | Metric to sort by |
235
+
236
+ ---
237
+
238
+ ## Duplications (`/api/duplications/show`)
239
+
240
+ Get detailed duplicate code blocks for a specific file.
241
+
242
+ ### Parameters
243
+
244
+ | Parameter | Description |
245
+ | --------- | ----------- |
246
+ | `key` | File key (required) - format: `project-key:path/to/file.ts` |
247
+ | `branch` | Branch name |
248
+ | `pullRequest` | PR number |
249
+
250
+ ### Response
251
+
252
+ ```json
253
+ {
254
+ "duplications": [
255
+ {
256
+ "blocks": [
257
+ {
258
+ "from": 1,
259
+ "size": 20,
260
+ "_ref": "1"
261
+ },
262
+ {
263
+ "from": 50,
264
+ "size": 20,
265
+ "_ref": "2"
266
+ }
267
+ ]
268
+ }
269
+ ],
270
+ "files": {
271
+ "1": {
272
+ "key": "my-project:src/utils/helpers.ts",
273
+ "name": "helpers.ts",
274
+ "projectName": "My Project"
275
+ },
276
+ "2": {
277
+ "key": "my-project:src/utils/common.ts",
278
+ "name": "common.ts",
279
+ "projectName": "My Project"
280
+ }
281
+ }
282
+ }
283
+ ```
284
+
285
+ ### Workflow: Find All Duplicates
286
+
287
+ ```bash
288
+ # 1. Get files with most duplication
289
+ curl -H "Authorization: Bearer $TOKEN" \
290
+ "https://sonarcloud.io/api/components/tree?component=$PROJECT&qualifiers=FIL&metricKeys=duplicated_lines_density&s=metric&metricSort=duplicated_lines_density&asc=false&ps=20"
291
+
292
+ # 2. For each file, get duplicate blocks
293
+ curl -H "Authorization: Bearer $TOKEN" \
294
+ "https://sonarcloud.io/api/duplications/show?key=my-project:src/file.ts"
295
+ ```
296
+
297
+ ---
298
+
299
+ ## Rules (`/api/rules/search`)
300
+
301
+ ### Parameters
302
+
303
+ | Parameter | Description |
304
+ | --------- | ----------- |
305
+ | `languages` | Filter by language |
306
+ | `severities` | Filter by severity |
307
+ | `types` | Filter by type |
308
+ | `tags` | Filter by tags |
309
+ | `q` | Search query |
310
+ | `p` / `ps` | Pagination |
311
+
312
+ ---
313
+
314
+ ## Sources (`/api/sources/*`)
315
+
316
+ ### Raw Source Code (`/api/sources/raw`)
317
+
318
+ | Parameter | Description |
319
+ | --------- | ----------- |
320
+ | `key` | File key (required) - format: `project:path/to/file.ts` |
321
+ | `branch` | Branch name |
322
+
323
+ ```bash
324
+ curl -H "Authorization: Bearer $TOKEN" \
325
+ "https://sonarcloud.io/api/sources/raw?key=my-project:src/utils/helpers.ts"
326
+ ```
327
+
328
+ ### SCM Blame (`/api/sources/scm`)
329
+
330
+ | Parameter | Description |
331
+ | --------- | ----------- |
332
+ | `key` | File key (required) |
333
+ | `from` | Start line |
334
+ | `to` | End line |
335
+
336
+ ```bash
337
+ curl -H "Authorization: Bearer $TOKEN" \
338
+ "https://sonarcloud.io/api/sources/scm?key=my-project:src/utils/helpers.ts"
339
+ ```
340
+
341
+ **Response**: Returns author, date, and revision for each line.
342
+
343
+ ---
344
+
345
+ ## Compute Engine (`/api/ce/activity`)
346
+
347
+ Get background task status (analysis jobs).
348
+
349
+ | Parameter | Description |
350
+ | --------- | ----------- |
351
+ | `component` | Project key |
352
+ | `status` | `SUCCESS`, `FAILED`, `CANCELED`, `PENDING`, `IN_PROGRESS` |
353
+ | `type` | Task type (e.g., `REPORT`) |
354
+ | `minSubmittedAt` | Filter by submission date |
355
+ | `maxExecutedAt` | Filter by execution date |
356
+ | `p` / `ps` | Pagination |
357
+
358
+ ```bash
359
+ curl -H "Authorization: Bearer $TOKEN" \
360
+ "https://sonarcloud.io/api/ce/activity?component=my-project&status=FAILED"
361
+ ```
362
+
363
+ ---
364
+
365
+ ## Quality Profiles (`/api/qualityprofiles/search`)
366
+
367
+ | Parameter | Description |
368
+ | --------- | ----------- |
369
+ | `language` | Filter by language |
370
+ | `project` | Project key |
371
+ | `qualityProfile` | Profile name |
372
+
373
+ ```bash
374
+ curl -H "Authorization: Bearer $TOKEN" \
375
+ "https://sonarcloud.io/api/qualityprofiles/search?language=ts"
376
+ ```
377
+
378
+ ---
379
+
380
+ ## Languages (`/api/languages/list`)
381
+
382
+ List all supported languages.
383
+
384
+ ```bash
385
+ curl -H "Authorization: Bearer $TOKEN" \
386
+ "https://sonarcloud.io/api/languages/list"
387
+ ```
388
+
389
+ **Response**: `{ "languages": [{ "key": "ts", "name": "TypeScript" }, ...] }`
390
+
391
+ ---
392
+
393
+ ## Branches (`/api/project_branches/list`)
394
+
395
+ | Parameter | Description |
396
+ | --------- | ----------- |
397
+ | `project` | Project key (required) |
398
+
399
+ ```bash
400
+ curl -H "Authorization: Bearer $TOKEN" \
401
+ "https://sonarcloud.io/api/project_branches/list?project=my-project"
402
+ ```
403
+
404
+ **Response**: `{ "branches": [{ "name": "main", "isMain": true, "type": "LONG", "status": { "qualityGateStatus": "OK" } }] }`
405
+
406
+ ---
407
+
408
+ ## Badges (`/api/project_badges/*`)
409
+
410
+ ### Measure Badge (`/api/project_badges/measure`)
411
+
412
+ | Parameter | Description |
413
+ | --------- | ----------- |
414
+ | `project` | Project key |
415
+ | `metric` | `bugs`, `coverage`, `code_smells`, `vulnerabilities`, etc. |
416
+ | `branch` | Branch name |
417
+
418
+ Returns SVG badge image.
419
+
420
+ ```bash
421
+ curl "https://sonarcloud.io/api/project_badges/measure?project=my-project&metric=coverage"
422
+ ```
423
+
424
+ ### Quality Gate Badge (`/api/project_badges/quality_gate`)
425
+
426
+ | Parameter | Description |
427
+ | --------- | ----------- |
428
+ | `project` | Project key |
429
+ | `branch` | Branch name |
430
+
431
+ ```bash
432
+ curl "https://sonarcloud.io/api/project_badges/quality_gate?project=my-project"
433
+ ```
434
+
435
+ ---
436
+
437
+ ## Pagination Example
438
+
439
+ ```bash
440
+ PAGE=1
441
+ while true; do
442
+ R=$(curl -s -H "Authorization: Bearer $TOKEN" \
443
+ "https://sonarcloud.io/api/issues/search?organization=$ORG&componentKeys=$PROJECT&p=$PAGE&ps=500")
444
+ echo $R | jq '.issues[]'
445
+ [ $((PAGE * 500)) -ge $(echo $R | jq '.total') ] && break
446
+ PAGE=$((PAGE + 1))
447
+ done
448
+ ```
449
+
450
+ ---
451
+
452
+ ## Error Codes
453
+
454
+ | Code | Meaning | Fix |
455
+ | ---- | ------- | --- |
456
+ | 401 | Invalid token | Check `SONARCLOUD_TOKEN` |
457
+ | 403 | No permission | Verify project access |
458
+ | 404 | Not found | Check project/org key |
459
+ | 400 | Bad request | Check parameter values |
460
+
461
+ ---
462
+
463
+ ## References
464
+
465
+ - [SonarCloud Web API](https://sonarcloud.io/web_api)
466
+ - [SonarCloud Docs](https://docs.sonarsource.com/sonarcloud/)