Appearance
Introduction
The SoftProbe CLI (sp) is the command-line interface to the SoftProbe backend (sp-boot). It is specified AI-agent first: stable JSON output, predictable exit codes, and artifact files for large diagnosis payloads.
Single public surface
All documented commands call sp-boot over HTTP (:8090 by default). The public sp binary must not include an embedded source VFS or other path to read proprietary Java/backend code — see Non-goals.
Implementation lives in sp-cli. This documentation describes the full target (v1 + v2) so implementers and skill authors can work in parallel.
Who uses sp?
- AI coding agents — replay failure diagnosis, trace lookup by business ID, policy validation, automated re-runs
- CI/CD — policy gates on pull requests, scheduled replay smoke tests
- Platform engineers — same commands as agents, often without
--json
The web UI remains the place for rich workspace editing; the CLI covers scriptable and agent workflows.
Relationship to other tools
| Tool | Role |
|---|---|
| Web UI | Full filesystem, visual diff, manual case editing |
| Java agent | In-process recording; talks to storage APIs directly |
spcode + sp_api | OpenCode plugin; migrates to sp subcommands |
| Policy YAML guide | Schema for sp policy inputs |
Documentation map
- For AI agents — start here if you write skills or tools
- Commands (v1) — platform control commands
- Commands (v2) — diagnosis and console parity
- Implementer spec — for Go CLI developers