agents-in-a-box — documentation

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

If you’re looking for a specific topic, start here:

Section	What’s in it
Product	What agents-in-a-box is, value, high-level architecture
TUI	The ainb terminal app + CLI
Toolkit	Portable skills, agents, workflows
Plugins	v2 subprocess plugin system
Knowledge	reflect / recall GraphRAG + QMD
Contributing	Build, test, ship
Reference	Architecture, glossary, deep dives

---

Product

• What is agents-in-a-box?
• Value proposition
• Whole-system architecture

TUI

The ainb terminal app and its CLI.

• Overview
• Install
• First session quickstart
• Attaching to sessions — full-screen and in-pane tmux attach
• CLI reference — every subcommand, every flag
• Keyboard shortcuts
• Architecture
• FAQ

Toolkit

Portable AI-coding agent toolkit. Skills, agents, workflows — deployed to 9 AI tools.

• Overview
• Skills (86)
• Agents (37)
• Bootstrap engine

Plugins

Read this first if you’re confused: plugins/README.md — the word “plugin” means two different things in this repo. The index disambiguates.

The v2 subprocess plugin system for the ainb TUI:

• What is an ainb plugin?
• User guide — install, configure, troubleshoot
• Authoring guide — write your own
• Wire spec v2 — the JSON-RPC contract
• Changelog

Knowledge

The two-tier learning capture and retrieval system.

• How reflection works
• reflect CLI reference

Contributing

• Building from source
• CI / CD
• Release process

Reference

• Architecture deep-dive
• Glossary

---

How this tree maps to the legacy layout

The pre-restructure layout had docs scattered across three places. Here’s the mapping:

New location	Source (legacy)
docs/tui/cli.md	ainb-tui/docs/CLI.md
docs/tui/faq.md	ainb-tui/docs/FAQ.md
docs/toolkit/overview.md	toolkit/README.md (TOC + intro)
docs/plugins/overview.md	new — disambiguates
docs/plugins/user-guide.md	docs/plugins.md
docs/plugins/authoring.md	docs/plugin-authoring.md
docs/plugins/spec-v2.md	docs/plugin-spec/v2.md
docs/plugins/changelog.md	docs/plugin-spec/CHANGELOG.md
docs/knowledge/overview.md	docs/how-reflection-works.md

The migration is complete: every page in this tree is now authoritative and the legacy paths have been removed. The table above is retained only to document provenance.

---

Editing rules

• Markdown is the source format. Astro Starlight renders to HTML at build time.

• Code blocks: always tag the language for syntax highlighting.

• Cross-link other docs with relative paths ([…](../plugins/spec-v2.md)).

• Heading style: # once per file (title), then ## and below for sections.

• Frontmatter (Starlight-style) only on files that override the title or sidebar position:

  ---
  title: "Plugin authoring guide"
  sidebar:
    order: 2
  ---

• Use admonitions sparingly: > [!note], > [!warning], > [!tip].