documentation

How to wire brink into your stack.
And what it does once you have.

The docs are deliberately small: a 10-minute quickstart, the concepts you need, three platform deep-dives, and a generated API reference. Everything else is either obvious from the dashboard or wrong.

01 · ten minutesguides

Quickstart

Connect a staging URL, drop in two synthetic accounts, see the first confirmed exploit. End to end, no sales call.

02 · modelguides

Concepts

Targets, scopes, projects, runs, findings, coverage. The mental model you need before you start trusting our inbox.

03 · directing the fleetplatform

Agents

The operator's manual for the agent fleet: what each agent does, how to point them at the right surface, and how to read what they ship.

04 · headlessplatform

CLI

For when you want to script onboarding, kick off runs from CI, or tail findings from your terminal. Same auth, same scope rules.

05 · machine-readableplatform

API reference

Every API endpoint the dashboard uses, generated from the live router. Auth tier, input / return shape, and common error codes for each.

prefer to skim a real screen?

Every doc here has a paired demo at /demo. Read the concept once, then click around the actual UI to see what it produces.

The docs are versioned alongside the dashboard. The selector in the top-left of the sidebar will let you pin to a previous platform version once we tag the first stable release — for now everything is v0.41 · pre-1.0.

getting started

New here? Start with the quickstart — it walks you through your first confirmed exploit.