Skip to content

Installation

Prerequisites

DependencyVersionRequired?Purpose
Rust toolchainstable (1.80+)YesBuilding SPT crates
Git2.30+YesSource control, worktrees for parallel agents

Optional dependencies unlock additional capabilities:

DependencyVersionPurpose
Go1.21+Building the sptx workspace CLI
wasm-packlatestWebAssembly builds (spt-wire-wasm)
Docker20+Containerized development and dashboards

Using SPT in Your Project

This is the path for developers who want to use spt in their own projects.

bash
cargo install spt-cli

This installs the spt CLI binary with vector DB, agent orchestration, swarm coordination, and MCP tools.

Homebrew (macOS)

bash
brew tap smartpointstech/tap
brew install spt

Universal script

bash
curl -sSL https://raw.githubusercontent.com/SmartPointsTech/spt/main/scripts/install.sh | bash

Windows Support

Windows installation via winget install SmartPointsTech.spt and choco install spt is available for release builds. For development, use the cargo install method.

Verify

bash
spt --version
spt doctor

See spt doctor for a detailed breakdown of every check.

Claude Code Integration

Register the MCP server so Claude Code can access orchestration tools:

bash
claude mcp add spt -- spt mcp start

Developing SPT Itself

This is the path for contributors working on the spt monorepo.

Clean install script

If you have old versions of spt, sptx, or sptflo from previous installs, use the cleanup script first:

bash
# See what's installed (safe — changes nothing)
./scripts/clean-install.sh --clean-only --dry-run

# Remove everything and set up for development
./scripts/clean-install.sh --dev

The script handles: Homebrew formulas, global npm packages, npm links, cargo installs, orphan binaries, stale npx cache.

Manual setup

bash
# Clone the monorepo
git clone https://github.com/SmartPointsTech/spt.git
cd spt

# Build all Rust crates
cargo build --release

# Install the CLI locally
cargo install --path crates/spt-cli

Optional: Go CLI

bash
cd cli && make build
mkdir -p ~/.local/bin
ln -sf "$(pwd)/dist/sptx" ~/.local/bin/sptx

Dev workflow

TaskCommand
Build all cratescargo build
Build a specific cratecargo build -p <crate>
Run Rust testscargo test
Run Go testscd cli && go test ./...
Build docs locallynpm run docs:dev
Switch back to released versions./scripts/clean-install.sh --user

Switching Between Modes

bash
# Currently developing spt, want to switch to using a released version:
./scripts/clean-install.sh --user

# Currently using released spt, want to switch to developing:
cd ~/work/spt && ./scripts/clean-install.sh --dev

# Nuclear option — remove everything:
./scripts/clean-install.sh --clean-only

Next Steps

Released under the MIT License.