Softprobe CLI

Appearance

Installation ​

sp binary ​

Release builds are produced by build.sh (build_sp_cli) and uploaded as:

text
gs://softprobe-published-files/sp/<version>/sp-{os}-{arch}

Supported platforms (release): linux/amd64, linux/arm64, darwin/amd64, darwin/arm64, windows/amd64, windows/arm64.

Install on PATH ​

bash
# Example: Linux amd64
curl -fsSL -o sp "https://<your-distribution-host>/sp/1.0.0/sp-linux-amd64"
chmod +x sp
sudo mv sp /usr/local/bin/
sp version

Exact download URLs depend on your organization's artifact hosting.

Verify ​

bash
sp version
sp health --json    # requires sp-boot running (when implemented)

Backend Setup & Configuration ​

Softprobe offers two deployment modes: Softprobe Cloud (SaaS) and Self-Hosted / Enterprise.

Softprobe Cloud (SaaS) ​

  • No local backend setup is required. All API commands point directly to https://api.softprobe.ai by default.
  • No manual configuration is required. Running sp auth login will automatically initialize your directories and write your active profile and auth token.

Self-Hosted / Enterprise ​

  • Ensure your private sp-boot instance is running and reachable on your network (typically defaults to http://127.0.0.1:8090).
  • Run sp auth login and select the Self-Hosted option to configure your custom API URL. Since these run inside private networks, no authentication token is required.

Manual Configuration Initialization ​

If you want to manually create the configuration files without running the interactive sp auth login, you can initialize them at any time:

bash
sp config init
# creates ~/.config/softprobe/config.jsonc and ~/.config/softprobe/sp.jsonc

See Configuration for advanced settings.

spcode AI Engine CLI ​

The local autonomous AI engine and developer companion.

Installation Options ​

Homebrew (macOS & Linux) ​

bash
brew install softprobe-ai/tap/spcode

Node Package Manager (NPM or Bun) ​

bash
npm install -g softprobe-ai@latest
# or using Bun
bun install -g softprobe-ai@latest

Curl Shell Installer (macOS & Linux) ​

bash
curl -fsSL https://softprobe.ai/install | bash

Once installed, verify the installation:

bash
spcode --version

See the spcode CLI guide for detailed configuration and command references.