Documentation
Install bingo, work in the terminal, and build on the kernel.
Start here: InstallationGuide
From installation to everyday work. Learn the terminal, choose a model, and set the boundaries.
- Installation Build bingo from source with a stable Rust toolchain, and check the binary answers.
- Quick start Sign in to a provider, run a first turn, and read the permission card bingo puts in front of you.
- The terminal surface The grammar bingo draws in, the keys that drive it, and how sub-agents and rooms appear as rows you can step into.
- Running headless One turn on a pipe with --print, the three output formats, the host protocol on stdin, and the JSON-RPC server.
- Providers and models The providers bingo ships with, how a credential gets in, named instances for extra endpoints, and how a model is chosen.
- Settings and permissions The settings layers and how they merge, the five permission modes, the rule grammar, and shell hooks.
- Channels, the gateway and schedules Put a session in a chat thread, keep one resident bingo per data directory, and defer or repeat a turn.
- Skills and MCP servers Two ways to add to what bingo can do: procedures written down as files, and tools from another process.
Developers
Understand the kernel, follow the event stream, and extend bingo with your own plugins.
- Architecture A minimal kernel, everything else a plugin, and one direction of dependency the build asserts.
- The event stream One frame type, one journal, two pure reducers, and every surface a client of them.
- Plugins in Rust The Plugin trait, the eleven contributions a plugin may register, and the worked example to read first.
- Cross-process plugins Ship a bingo-native tool, command, hook, contributor, compactor or provider in any language, over JSON-RPC on stdio.
- Wire services How one plugin reaches another's behaviour, in process by type and across processes by key, method and schema.
- UI as data One view vocabulary, three lanes chosen by durability, and a degrade rule so no surface loses information.
- Schemas and protocols The two committed JSON Schemas, the versions they carry, and the three wire formats bingo speaks.
- The ADR index Every boundary decision in bingo, one line each, in the order they were taken.