Installation

Choose the path that matches where you will run load generators (workers), not only where the CLI lives.

Docker Compose (recommended for first run)

Best for local development, examples, and CI smoke tests on a single machine.

One-liner (clone + start stack):

curl -fsSL https://raw.githubusercontent.com/MohamedBenTaher/test-scale/main/setup.sh | bash

From a clone (full control, rebuilds app images):

git clone https://github.com/MohamedBenTaher/test-scale.git
cd test-scale
make quickstart

Prerequisites: Docker Compose v2, Go 1.26.5+ (for building images), curl, jq.

Homebrew (CLI only)

Installs the test-scale CLI. You still need a running control plane (Docker or Kubernetes).

brew install MohamedBenTaher/tap/test-scale

Point the CLI at your control plane:

export CONTROL_PLANE_URL=http://localhost:8080
export TEST_SCALE_API_KEY=local-dev-key   # see deploy/docker/scripts/ports.sh after docker-up

Release binaries

Tagged releases on GitHub Releases include binaries, checksums, SBOMs, and signatures.

Kubernetes (existing cluster)

For scale-out workers and production-style operation:

helm install test-scale \
  oci://ghcr.io/mohamedbentaher/charts/test-scale \
  --version 0.1.1 \
  --namespace test-scale --create-namespace

The default chart is a self-contained demo. For shared clusters, start from values-production.yaml, use managed Postgres and NATS, and create secrets before install. See Kubernetes deployment and the operator guide.

Images: ghcr.io/mohamedbentaher/test-scale (multi-arch, signed).

From source

git clone https://github.com/MohamedBenTaher/test-scale.git
cd test-scale
make build
./bin/test-scale --help

Or install the CLI globally:

go install github.com/MohamedBenTaher/test-scale/cmd/cli@latest

Verify the install

Mode	Check
Docker	make docker-verify after make docker-up
CLI only	test-scale open or curl -s "$CONTROL_PLANE_URL/ping"

Continue with the first-run guide.