Home

AgentBridge — user documentation

This folder ships next to the executable in every release archive (docs/) and is the reference for people who install and operate AgentBridge. The developer documentation lives in docs-dev/ in the repository and is not distributed.

Beginner guides

A series of short guides written in plain language for anyone who uses AgentBridge day to day. No technical knowledge is needed: each guide covers one aspect, in the order you are most likely to meet it.

Guide	What it covers
How AgentBridge works	What an AI agent is, what tools are and how to enable them, the documents area, attachments
Getting started	Download, first start, the first indexing
Choosing your AI	Cloud and local providers, API keys, switching
Chatting with your agent	The chat window, files, sessions, the web version
Your documents area	The folder the agent reads, indexing, asking questions
Creating documents	Word, Excel, PowerPoint and PDF from a request
Email	Reading and sending mail with your account
Web research	Searching the internet, sources and reports
Voice	Dictating and hearing the assistant speak
Phone access	Calling the assistant, the PIN, voice calls
Telegram	Chatting with the assistant in Telegram
Scheduled tasks	Deadlines and recurring work the agent does alone
Podcasts	Complete podcast episodes from one request
Privacy and security	The sandbox, anonymisation, what leaves your machine
The agent's memory	How the assistant remembers your work
Updates	How updates work and what they never touch

Guides

Guide	What it covers
Manual	Start here — install, configure the JSON files, use the terminal UI, connect OpenAI or MCP clients
Terminal UI reference	Every command, shortcut and mouse action
HTTP API reference	All endpoints: chat, sessions, LLM switching, TTS, voice, files, MCP connector
Telegram chat	Connect the agents to Telegram: config, first login, allow-list, attachments
SIP telephony	Phone-gate the agents: config, PIN/allow-list security, NAT/trunk, STT deployment
SIP entry point	Unattended Kamailio + rtpengine entry-point installation
Auto-update	How the automatic update works and what it never touches
OfficeManager	The 16-bit office view of your agents (served at /OfficeManager)
Crash reporting	Privacy-safe crash diagnostics to the GitHub repository — what is sent and how to disable it
AIOrchestrator white paper	Why the AIOrchestrator library model outperforms MCP deployments
Disclaimer	Warranty and liability terms, including AI-generated content and autonomous agent actions
Windows installer · Linux/macOS installer	One-line installers for the release archives

Rules for contributors

• User guides live in this folder. They are copied to the build output and into every release archive automatically — if a guide is not here, it never reaches the installed app.
• Developer guides (architecture, release pipeline, TUI internals) live in docs-dev/ and are not shipped.
• media/ holds README demo assets only — never shipped.