Skip to content

sp diagnose

When agents use this: One-shot workflows that combine progress, report, storage, and trace APIs — fewer manual steps than chaining low-level commands.

Synopsis

SubcommandDescription
replay <planId>Plan progress, failed cases, diff artifacts on disk
trace <traceId>Record trace, completeness, summary artifacts

diagnose replay

Replaces the manual sequence in Diagnose replay failure:

bash
sp diagnose replay plan-abc123 --failed-only --out-dir .sp-work --json
FlagDefaultDescription
--failed-onlytrueFilter to cases with compare failures
--out-dir.sp-workWrite {planId}/{planItemId}-diff.json files
--page / --limitglobalPagination for case query

Steps performed:

  1. GET /progress?planId=…
  2. POST /api/report/queryReplayCase with diffResultCode=1 when --failed-only
  3. For each failed case with diffId: GET /api/report/queryDiffMsgById/{id} → artifact file

Example data shape:

json
{
  "planId": "plan-abc123",
  "status": "FINISHED",
  "failedCaseCount": 2,
  "artifacts": [
    ".sp-work/plan-abc123/item-1-diff.json"
  ],
  "nextActions": [
    "sp record trace <traceId> --json"
  ]
}

diagnose trace

bash
sp diagnose trace 4bf92f3577b34da6a3ce929d0e0e4736 --out-dir .sp-work --json

Fetches:

  • GET /api/storage/record/trace/{traceId}
  • GET /api/storage/record/completeness?traceId=…
  • Trace summary (when available)

Writes JSON under {outDir}/trace-{traceId}/ and returns a summary plus nextActions (e.g. sp record query --trace-id …).

零代码改动 · 全上下文可见性 · 成本优化