SoftProbe CLI

Appearance

SoftProbe CLI`sp` — agent-first backend control

Complete specification for AI coding agents and CLI implementers. Documentation only until the binary catches up.

For AI agents
Quickstart

JSON-first

Stable `--json` output, exit codes, and artifact paths so OpenCode, Claude Code, and Codex can script replay diagnosis without parsing tables.

Backend API only

Commands talk to sp-boot for apps, policies, replay, traces, and reports — no embedded proprietary source in the public CLI.

v1 + v2 spec

Platform control (v1) and investigation/console parity (v2) are fully documented so implementers can ship incrementally.

What is sp? ​

sp is the SoftProbe command-line interface. It is designed primarily for AI agents that automate replay diagnosis, policy changes, and CI gates. Humans and shell scripts use the same commands.

All public commands are HTTP clients to sp-boot (default http://127.0.0.1:8090). The CLI does not ship or expose embedded backend source — that would risk leaking proprietary code. See Non-goals.

Roadmap ​

PhaseStatus in binaryDocumented
v1Plannedconfig, auth, app, policy, replay control, health
v2Plannedrecord, trace, replay data, workspace, groups, ops
  • Policy YAML guide — schema for recording, mock, and compare policies
  • spcode / @spcode/plugin — OpenCode integration; migrates from sp_api endpoints to sp subcommands

Build the docs locally ​

bash
cd docs-site
npm install
npm run docs:dev