8251321dac
New structure: docs/ split into 11 subdirectories (getting-started/, agents/, providers/, sidecar/, multi-machine/, plugins/, config/, production/, architecture/, contributing/, pro/). New files: - docs/README.md: navigation index with audience table - docs/getting-started/quickstart.md: install, build, first session - docs/config/ref-settings.md: all env vars, config files, databases - docs/architecture/overview.md: split from architecture.md (>300 lines) - docs/pro/README.md: Pro edition overview - docs/pro/features/analytics.md: analytics dashboard docs - docs/pro/features/cost-intelligence.md: budget + router docs Remaining docs being written by background agents — will be committed in follow-up when complete. |
||
|---|---|---|
| .. | ||
| architecture | ||
| config | ||
| getting-started | ||
| pro | ||
| progress | ||
| provider-adapter | ||
| architecture.md | ||
| decisions.md | ||
| e2e-testing.md | ||
| findings.md | ||
| multi-machine.md | ||
| orchestration.md | ||
| phases.md | ||
| production.md | ||
| README.md | ||
| release-notes.md | ||
| sidecar.md | ||
Agents Orchestrator — Documentation
Multi-project AI agent dashboard with terminal, SSH, and multi-provider session management. Built with Tauri 2.x (Rust) + Svelte 5 + Claude Agent SDK.
Source of truth. Before making changes, consult these docs. After making changes, update them.
Quick Navigation
| Audience | Start Here |
|---|---|
| New users | Getting Started |
| Contributors | Dual-Repo Workflow, Testing |
| Pro customers | Pro Edition, Marketplace |
| Plugin developers | Plugin Development Guide |
Documentation Map
Getting Started
- Quickstart — install, build, first agent session
Architecture
- System Overview — components, data flow, IPC patterns
- Data Model — SQLite schemas, layout, keyboard shortcuts
- Decisions — architecture decision log with rationale
- Phases — v2 implementation phases (P1-7 + multi-machine A-D)
- Research Findings — SDK, performance, coupling analysis
Agents & Orchestration
- Orchestration — btmsg, bttask, 4 management roles, wake scheduler, session anchors
- btmsg Reference — inter-agent messaging CLI and database schema
- bttask Reference — kanban task board CLI and operations
Providers
- Provider Reference — Claude, Codex, Ollama, Aider: models, capabilities, routing
Sidecar
- Sidecar Architecture — runners, NDJSON protocol, crash recovery, env stripping
Multi-Machine
- Relay Architecture — WebSocket server, TLS, SPKI pinning, reconnection
Production Hardening
- Hardening — sidecar supervisor, Landlock sandbox, WAL checkpoint, TLS relay
- Features — FTS5 search, plugin sandbox, secrets, notifications, audit, error classification
Configuration
- Settings Reference — env vars, config files, databases, themes, per-project settings
Plugins
- Plugin Development Guide — Web Worker sandbox API, manifest, publishing, examples
Contributing
- Dual-Repo Workflow — community vs commercial repos, sync, leak prevention
- Testing — E2E fixtures, test mode, LLM judge, CI integration
Pro Edition (Commercial)
- Pro Overview — feature list, plugin architecture, IPC pattern
- Analytics Dashboard — cost/token/model tracking over time
- Cost Intelligence — budget governor, smart model router
- Knowledge Base — persistent memory, codebase symbol graph
- Git Integration — context injection, branch policy
- Marketplace — 13 plugins (8 free + 5 paid), catalog, install/update
Release History
- Release Notes — v3.0 features, breaking changes, requirements
Progress Logs
- v3 Progress — session-by-session development log
- v2 Progress
- v2 Archive
Key Directories
| Path | Purpose |
|---|---|
src-tauri/src/ |
Rust backend: commands, SQLite, btmsg, bttask, search, secrets, plugins |
agor-core/ |
Shared Rust crate: PtyManager, SidecarManager, EventSink, Landlock sandbox |
agor-relay/ |
Standalone relay binary for remote machine support |
agor-pro/ |
Commercial plugin crate (Pro edition features) |
src/lib/ |
Svelte 5 frontend: components, stores, adapters, utils, providers |
src/lib/commercial/ |
Pro edition Svelte components and IPC bridge |
sidecar/ |
Agent sidecar runners (Claude, Codex, Ollama, Aider) — ESM bundles |
tests/e2e/ |
WebDriverIO E2E tests, fixtures, LLM judge |
tests/commercial/ |
Pro edition tests (excluded from community builds) |
scripts/ |
Build scripts, plugin scaffolding, test runner |
.githooks/ |
Pre-push leak prevention hook |
Reading Order for New Contributors
- Getting Started — build and run
- System Overview — how the pieces fit
- Decisions — why things are built this way
- Sidecar Architecture — how agent sessions run
- Orchestration — multi-agent coordination
- Testing — how to test changes
- Dual-Repo Workflow — how to contribute