Skip to content

sp setup ​

Command reference. Install flow, Spcode Service, and systemd ops are documented in Install Softprobe.

bash
sp setup
sp setup --api-url http://127.0.0.1:8090 --json
sp setup --install-spcode-service --json
sp setup --uninstall-spcode-service --json
sp setup doctor --json
FlagDescription
--api-urlSoftprobe API URL (backend base URL)
--install-spcode-serviceInstall Spcode Service (Linux only)
--uninstall-spcode-serviceRemove Spcode Service
--spcode-service-portListen port (default 4096)

JSON output (setup) ​

json
{
  "ok": true,
  "command": "setup",
  "data": {
    "status": "configured",
    "profile": "default",
    "apiUrl": "http://127.0.0.1:8090",
    "spcodeServiceStatus": "skipped"
  }
}

When --install-spcode-service or --uninstall-spcode-service is provided:

json
{
  "ok": true,
  "command": "setup",
  "data": {
    "spcodeServiceStatus": "installed",
    "spcodeServicePort": 4096
  }
}

JSON output (setup doctor) ​

Validate setup configuration and local agent jar:

json
{
  "ok": true,
  "command": "setup doctor",
  "data": {
    "status": "healthy",
    "profile": "default",
    "apiUrl": "http://127.0.0.1:8090",
    "agentJar": "/home/user/.local/share/softprobe/agent/sp-agent.jar",
    "agentJarExists": true,
    "checks": [
      {
        "name": "config",
        "status": "healthy",
        "detail": "http://127.0.0.1:8090"
      },
      {
        "name": "agentJar",
        "status": "healthy",
        "detail": "/home/user/.local/share/softprobe/agent/sp-agent.jar"
      }
    ]
  }
}

Capture Sessions · Review Steps · Improve what matters