SDK Installation — bRRAIn Docs

System requirements, installation methods, Handler setup, and verification for the bRRAIn SDK.

Installation

System requirements

  • Go 1.22 or later (go version to confirm)
  • Handler — local Docker container or hosted endpoint
  • Network access from your app to the Handler (loopback for local, TLS for hosted)
  • Architecture — amd64 or arm64; the SDK and Handler both ship for both

Installation methods

Recommended: go get

go get github.com/Qosil/bRRAIn/sdk

Confirm:

go list -u -m github.com/Qosil/bRRAIn/sdk

Vendoring (air-gapped builds)

go mod vendor

All SDK dependencies are vendored under vendor/github.com/Qosil/bRRAIn/.

Build from source

Clone and build if you need to patch locally:

git clone https://github.com/Qosil/bRRAIn.git
cd bRRAIn/sdk
go build ./...

Reference the cloned module using a replace directive in your go.mod:

replace github.com/Qosil/bRRAIn/sdk => ../bRRAIn/sdk

Handler setup

The Handler performs classification, summarization, and graph-aware routing. It must be reachable from your SDK client.

Option A — Local Docker (development)

docker pull qosil/brrain-handler:latest
docker run -p 8080:8080 qosil/brrain-handler:latest

Option B — Hosted (free tier)

Sign up at app.brrain.io. Hosted Handler access is included in every tier.

client := sdk.NewClient(apiKey,
    sdk.WithHandler("https://handler.brrain.io"),
)

Option C — Self-hosted on your infrastructure

Helm chart and Docker Compose manifests are available at github.com/Qosil/bRRAIn/deploy. Use Option C for regulated-industry deployments where data must stay within your VPC.

Verification

Run the verification script:

go run github.com/Qosil/bRRAIn/sdk/cmd/verify@latest

Expected output:

✓ SDK version: v1.2.3
✓ Handler reachable at http://localhost:8080
✓ API key valid
✓ Workspace create/delete round trip: 142 ms

Any failures surface with explicit remediation steps.

Next