forcedotcom/sf-skills / skills/dx-apexguru-scan
dx-apexguru-scan
VerifiedRun an ApexGuru performance scan on a Salesforce Apex project via the ApexGuru SFAP Scan API. Zips the project's Apex (any layout), submits it, polls to completion, decodes the base64 report, and presents performance antipattern violations (SOQL in loop, DML in loop, Schema.getGlobalDescribe(), SOQL without WHERE/LIMIT, unused SOQL fields) grouped by rule with severity, file:line, and suggested fixes — clearly attributed as 'Static only' or 'Production insights'. TRIGGER when the user says 'run ApexGuru', 'ApexGuru scan', 'check Apex performance', 'find governor-limit / performance antipatterns', 'SOQL in loop', 'scan my Apex for performance', or 'ApexGuru performance insights'. DO NOT TRIGGER for general static analysis or security scans (use dx-code-analyzer-run), for fixing code without scanning, or for onboarding an org to ApexGuru.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 20.4 KB |
| examples/README.md | markdown | 2.8 KB |
| examples/sample-decoded-summary.json | config | 4.3 KB |
| examples/sample-full-no-runtime-response.json | config | 27.6 KB |
| examples/sample-succeeded-response.json | config | 1.7 KB |
| references/api-reference.md | markdown | 2.5 KB |
| references/authentication.md | markdown | 7.1 KB |
| references/error-handling.md | markdown | 3.7 KB |
| references/violation-catalog.md | markdown | 2.1 KB |
| scripts/build-zip.shexecutable | script | 3.8 KB |
| scripts/decode-report.jsexecutable | script | 19.4 KB |
| scripts/resolve-token.shexecutable | script | 9.8 KB |
| scripts/run-scan.shexecutable | script | 6.5 KB |
| scripts/scan.shexecutable | script | 3.7 KB |
| scripts/validate-token.js | script | 5.5 KB |
references/api-reference.md
View on GitHub# ApexGuru SFAP Scan API Reference
**Base URL (production):** `https://api.salesforce.com/platform/scale/v1-beta.1/apex-guru`
The host is chosen from the token's environment (prod/stage/dev); `stage.` and
`dev.api.salesforce.com` are internal-only. Customers on a prod org always hit
production. See `authentication.md` for the routing table.
**Auth:** `Authorization: Bearer <sfap_api JWT>`. Org comes from the token's
`tnk` claim (`core/<instance>/<orgId>`) — no org id in the request.
## Call 1 — Submit a scan
```http
POST /scan
-H "Authorization: Bearer $JWT"
-F "file=@project.zip;type=application/zip"
[ -F "fastMode=true" ] # optional: skip LLM-heavy fix generation → faster/cheaper
```
- Zip may use **any** layout — the API walks the whole archive and extracts
every Apex file it finds. No `force-app/` tree at the root is required
(`build-zip.sh` collects every `.cls`/`.trigger` under the project root,
preserving relative paths).
- Limits: **200MB compressed**, **1GB decompressed**.
- Success → `202`:
```json
{ "scanId": "…", "status": "QUEUED" }
```
## Call 2 — Poll for result
```http
GET /scan/{scanId}
-H "Authorization: Bearer $JWT"
```
- Status progression: `QUEUED → RUNNING → SUCCEEDED` (or `FAILED`).
- Poll ~every **15s**.
- On `SUCCEEDED`:
```json
{
"scanId": "…",
"status": "SUCCEEDED",
"analysisMode": "static", // "static" = source-only | "full" = org onboarded, runtime metrics
"violationCount": 39,
"filesScanned": 16,
"violationBreakdown": { "SOQL_IN_LOOP": 15, "DML_IN_LOOP": 8, "GGD": 2 },
"report": "<base64-encoded JSON array of violations>",
"message": null
}
```
## The `report` field
Base64 → decode → **JSON array of violations**. Each violation carries:
- `rule` — the antipattern id (e.g. `SOQL_IN_LOOP`).
- `message` — human-readable description.
- `severity` — 1 (Critical) … 5 (Info).
- source location — `file` + `line`.
- suggested fix(es).
- help-doc `resources`.
`decode-report.js` tolerates field-name drift (`location`/`locations[0]`,
`fixes`/`suggestedFixes`, `severity`/`sev`) so minor API-shape changes don't break parsing.
## Status codes
| Code | Meaning |
|------|---------|
| 202 | Scan accepted (submit) |
| 200 | Poll OK |
| 400 | Malformed zip, no Apex inside, or over size limit |
| 401 | Bad / expired / wrong-env token |
| 403 | Scan owned by a different org (token `tnk` mismatch) |
| 404 | Unknown scanId, or archived (~30-day GC) |
See `error-handling.md` for resolutions.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |