agents-in-a-box: documentation

Canonical source of truth for the monorepo. Everything published to the website under /docs/* is rendered from these files.

1. Start here

• Overview: what ainb is, who it is for, component breakdown
• Install: Homebrew, curl script, prebuilt binaries, cargo build
• Quickstart: first session in 60 seconds
• Concepts: workspaces, worktree isolation, tmux persistence, attention
• Keyboard shortcuts: complete keybindings table

2. Using ainb

• Starting a new session: repo picker and new-session wizard
• Attaching to sessions: full-screen and in-pane live tmux attach
• Code review diff: Warp-style diff viewer with collapsible hunks
• Fleet and chat bridge: drive the fleet from Telegram, Slack or Discord
• ATC background watcher: always-on watcher and session lifecycle
• Shared MCP pool: shared MCP server pool across sessions
• Token optimisation: Headroom proxy and RTK context compression
• Inbox and notifications: ainb-hooks notification feed
• Browser dashboard: read-only web view (ainb web)

3. Configure and Extend

• Value proposition: detailed comparison and workflow impact
• Plugins overview: subprocess plugin system v2
• Plugins user guide: installing and configuring plugins
• In-tree plugins:
  • burndown: cost and spend tracking
  • session-reader: JSONL event streaming
  • witr: process causality tree
  • learnings: knowledge graph (guide moved to the reflect docs site)
  • abtop: fleet process monitor
• Skill manager guide: discovery, sync, drift check, and promotion
• Toolkit overview: portable skills and agents across 9 tools
• Reflect memory overview: GraphRAG and QMD knowledge capture
• Memory browser: reflect serve web interface (moved to the reflect docs site)

4. Reference

• CLI reference: generated from --help, verified in CI
• Plugin authoring guide: build native binary plugins
• Plugin wire spec v2: JSON-RPC protocol specification
• Fleet cost rollups: spend across sessions and budget alerts
• Observability overview: telemetry and causality
• OpenTelemetry to Grafana: Prometheus and dashboard setup
• Architecture deep-dive: whole-system architecture
• TUI architecture: ratatui host and event loop
• Repositories map: monorepo crate map
• Hangar control plane: task boards and autopilots
• Reflect memory internals (these pages moved to the reflect docs site):
  • The construct
  • Recall reference: 57 ports
  • Comparison

5. Help

• Troubleshooting and FAQ: common questions and fixes
• Daemons overlay: diagnostic overlay for background services
• Contributing guide: build, test, CI/CD, and release
• Glossary: terms and definitions