Installation
| Option | Use it for | Guide |
|---|---|---|
| One-line installer | the CLI: stampede run, init, compare, the console |
below |
| Homebrew or Scoop | the CLI, updated with your package manager | below |
stampede up |
the full stack (server, web UI, workers, database) from released images, no clone | below |
docker compose up in a clone |
the full stack plus the ShopLab demo | deploy/compose.md |
| Release archives | the same binary, downloaded by hand | GitHub releases |
| Offline bundle | networks without internet access | deploy/airgap.md |
| Helm chart | Kubernetes | deploy/helm.md |
| Operator | GitOps-style declared runs (alpha) | deploy/operator.md |
| Terraform examples | workers in several cloud regions | deploy/terraform.md |
There is one binary. It is the CLI, the server (stampede server), a worker
(stampede worker) and the terminal console (stampede on its own).
The CLI in one line
Section titled “The CLI in one line”curl -fsSL https://raw.githubusercontent.com/Ivan825/Stampede/main/install.sh | sh # Linux, macOSirm https://raw.githubusercontent.com/Ivan825/Stampede/main/install.ps1 | iex # Windows PowerShellThe script finds the latest release, downloads the archive for your OS and
CPU (amd64 or arm64), checks it against the release’s SHA-256 checksums
and installs stampede into ~/.local/bin (Windows:
%LOCALAPPDATA%\stampede\bin, added to your PATH). Read it first if you
prefer: it is short. Set STAMPEDE_VERSION=v1.0.0 for a particular
release, STAMPEDE_INSTALL_DIR for another folder, or
STAMPEDE_DOWNLOAD_BASE to download from an internal mirror of the
release files.
CI checks both scripts on Linux, macOS and Windows against a release built from every commit, including that a tampered archive is refused.
Homebrew and Scoop
Section titled “Homebrew and Scoop”brew install ivan825/tap/stampede # macOS, Linuxscoop bucket add ivan825 https://github.com/Ivan825/scoop-bucket # Windowsscoop install stampedeEvery release updates the tap
and the bucket, so
brew upgrade stampede and scoop update stampede bring the newest
version. Use the full name ivan825/tap/stampede with Homebrew: it marks
the cask as trusted, which Homebrew requires for casks outside its own
taps. The binaries are not notarised by Apple, so the cask removes the
quarantine flag macOS puts on Homebrew downloads; without that, macOS
would refuse to start stampede.
These install the CLI. The web UI runs in the server, which stampede up
starts with Docker, below.
The full stack without a clone
Section titled “The full stack without a clone”stampede up # needs Dockerstampede setup # create the organisation and owner; then open http://localhost:8080stampede down # stop it (add --volumes to delete its data)Outside a clone, stampede up writes a Compose file to your config
directory (~/.config/stampede/stack on Linux, ~/Library/Application Support/stampede/stack on macOS) and starts the released images of the
installed version: the server and web UI, two workers and TimescaleDB. Runs
reach an app on your own machine as http://host.docker.internal:<port>.
Inside a clone it uses the repository’s docker-compose.yml, which also
starts ShopLab.
Everything you do to the server is done with the CLI; the web UI is read only, for watching runs and reading reports, apart from the Stop, Kill and Kill all safety controls.
From source
Section titled “From source”git clone https://github.com/Ivan825/Stampedecd Stampedemake build # bin/stampede, with the web UI embeddedRequires Go 1.27 or later. Building the web UI from source needs Node 22 and
pnpm (make web); the repository includes a built copy, so make build
works without them.
Server requirements
Section titled “Server requirements”- PostgreSQL 15 or later. TimescaleDB is recommended and used by the Compose stack and Helm chart: per-second metrics become a compressed hypertable.
STAMPEDE_MASTER_KEY(32 random bytes, base64;stampede keygenprints one) to store secrets and AI provider keys. Without it, those features are disabled.- See configuration for every setting.