Skip to content

~/docs

Documentation

Everything here is the repository's own docs/ folder, published as it is on GitHub: the guides, the API reference, the architecture and every decision.

I want to try it

  1. 1Run it on your computer
  2. 2Connect one agent
  3. 3Chat, then run a mission
Getting started →

I want it always on

  1. 1A free student server or any Ubuntu box
  2. 2A free address with HTTPS
  3. 3Automatic updates
Deploy on a server →

I want to build on it

  1. 1The REST API and tokens
  2. 2MCP and A2A
  3. 3A new adapter for any agent
API reference →

18 of 18 docs

Start here

Getting startedFrom nothing to a finished mission: a workspace, an agent, a chat and a mission.docs/GETTING_STARTED.md
Set up with no domainEverything on free accounts: your Mac, Gmail email, a public address, Slack, push, MCP.docs/OWNER_SETUP.md

Run it

Deploy on a cloud serverAzure for Students or any Ubuntu server, with free HTTPS and automatic updates.docs/DEPLOY_CLOUD.md
Self-hostingDocker Compose or Helm, every setting, backups, upgrades and a smoke test.docs/SELF_HOST.md
Load test125 missions at once on one laptop: how it was run and what it measured.docs/LOAD_TEST.md

Build on it

ConnectorsEvery agent and model Brio can drive, by category, and how each one connects.docs/CONNECTORS.md
API referenceEvery REST route, generated from the code.docs/API.md
Writing an adapterAdd an agent or a model Brio does not know yet.docs/ADAPTERS.md
Adapter specThe AgentAdapter interface and every connector family.docs/ADAPTER_SPEC.md

How it works

ArchitectureServices, data model, the mission, task and attempt flows, sandboxes.docs/ARCHITECTURE.md
Planning, routing and verificationThe planner, the router, execution modes, the verifier and the scoreboard.docs/ROUTING_AND_QUALITY.md
Handoff packetsThe structured context that travels when work moves between agents.docs/HANDOFF_PACKET.md
Security and governanceVendor terms, the vault, sandboxes, data routing, budgets, approvals, the ledger.docs/SECURITY_GOVERNANCE.md

The project

Security reviewThe threat model, the method, every finding and what was fixed.docs/SECURITY_REVIEW.md
Product requirementsThe problem, the users, the requirements and how success is measured.docs/PRD.md
DecisionsEvery architectural decision, with its reasons and the alternatives.docs/DECISIONS.md
Build planMilestones M0–M10, their acceptance criteria and status.docs/BUILD_PLAN.md
ChangelogWhat each step added, with its evidence.docs/CHANGELOG.md

The shortest way in

Docker is all Brio needs. On your own computer it is three commands; on a fresh server, five. Then open the address, sign in and follow Getting started.

Something wrong or missing in the docs? Open an issue.

  1. $git clone https://github.com/Ivan825/brio_.git brio && cd brio/deploy/compose
  2. $./setup.sh
  3. $docker compose up -d
  4. $open http://localhost:8080