Quickstart
Operator fast lane

From clone to first controlled run in three gates.

This path is designed for engineering leaders: every phase has a clear command set, explicit verification, and a definition of done.

Gate 1: OnboardGate 2: HealthGate 3: Run Evidence
Step 1

Clone and onboard

Install dependencies and generate a clean onboarding report.

Step 2

Start control plane

Launch runtime services and verify health before run creation.

Step 3

Create first run

Create a run and confirm orchestration artifacts are visible.

Step 1: Clone and onboard

git clone <your-repo-url> BIOMETRICS
cd BIOMETRICS
./biometrics-onboard

Verify onboarding output

Run cat .biometrics/onboard/report.json and confirm no blocking failures.

Expected output: ready=true

Step 2: Start control plane

cd biometrics-cli
go run ./cmd/controlplane

Verify health

In another terminal, run curl -fsS http://127.0.0.1:59013/health (opens in a new tab).

Expected output: {"status":"ok"}

Step 3: Start first run

curl -fsS -X POST http://127.0.0.1:59013/api/v1/runs \
  -H "Content-Type: application/json" \
  -d '{"project_id":"biometrics","goal":"quickstart run","mode":"autonomous"}'

Verify run id

Response must include a non-empty run ID and an initial status.

Expected output: "id":"run-..."

Operator note

For production-like environments, capture event and graph evidence after first run creation. This baseline is required for incident and regression analysis.

Definition of done (quickstart)

  • Onboarding finished without blocking failures.
  • Control plane health endpoint returns status=ok.
  • A run can be created through /api/v1/runs.
  • Tasks endpoint for that run returns at least one task.

Continue

HomeInstall Hub