README.md

Trinity User Documentation

Auto-generated from source code. Run /generate-user-docs to update. Last sync: 2026-07-24.

What's New

• Release highlights — user-facing changes per release, newest first (v0.8.5)

FAQ

• Trinity FAQ — 280+ grounded answers to common questions, organized by topic (troubleshooting for symptom → fix)

Watch

• Video Library — workshops, demos, and deep-dives, newest first

Guides

• Deploying Trinity — Cloud vs self-hosted setup, step-by-step
• Using Trinity — UI tour: dashboard, agents, monitoring
• Building Agents — Create, develop, deploy with Claude Code + abilities

Getting Started

• Overview — What is Trinity, key concepts, architecture
• Setup — Installation, first-time setup, login
• Quick Start — Create your first agent in 5 minutes
• Roles and Permissions — 4-tier role model, user management
• Getting Help — Docs Q&A bot, community resources

Agents

• Creating Agents — Templates, GitHub repos, from scratch
• Agent Runtimes — Claude Code, OpenAI Codex, Gemini CLI
• Managing Agents — Start/stop, rename, delete, health
• Agent Data & Portability — Runtime data paths, export/import across instances
• Agent Chat — Chat interface, voice, streaming, history
• Agent Session — Resumable Claude session with full context
• Agent Terminal — Web terminal, SSH access, mode switching
• Agent Files — File browser, virtual filesystem, shared folders
• Agent Logs — Log viewing, telemetry, Vector aggregation
• Agent Configuration — Autonomy, read-only, resources, timeout
• Agent Guardrails — Deterministic safety enforcement, bash deny-lists, credential protection
• Self-Execute — Background tasks during chat, result injection

Credentials

• Credential Management — Adding, editing, hot-reload, encrypted backup
• OAuth Credentials — OAuth2 flows for Google, Slack, GitHub, Notion
• Subscription Credentials — Shared Claude subscriptions, auto-assign, auto-switch

Collaboration

• Agent Network — Multi-agent communication, async collaboration, Timeline replay
• Agent Permissions — Who can call whom, access control
• Event Subscriptions — Pub/sub + automatic task-completion report-back
• Shared Sessions (Rooms) — Several agents converse in one shared room (enterprise)
• System Manifest — Recipe-based multi-agent deployment, resilient deploy

Automation

• Scheduling — Cron schedules, execution queue, misfire handling
• Skills and Playbooks — Skills library, assignment, chat autocomplete
• Approvals — Human-in-the-loop approval gates
• Fan-Out — Parallel task dispatch and result collection
• Agent Loops — Bounded sequential task repetition, templates, stop signals, failure policy
• Agent Reminders — One-shot durable deferred self-triggers

Operations

• Dashboard — Grid and timeline views, tag clouds, activity feed
• Operations Page — Unified tabbed view: operator queue, notifications, health, executions
• Monitoring — Fleet health checks, agent heartbeats, cleanup service, retention sweeps
• Executions — Fleet execution list, stats, detail, live streaming, termination
• Audit Trail — Append-only administrative action log
• Telemetry — Local product events and opt-in fleet sharing
• Agent Quotas — Per-role agent creation limits

Sharing and Access

• Agent Sharing & Access — Access tab (operators), Sharing tab (external clients, channels, client roster)
• Access Control — Cross-channel email verification, access requests
• Public Links — Public chat URLs, email verification, session memory
• Customer Portal — Branded signed-in client chat app with history and file upload (enterprise)
• Tags and Organization — Tags, filtering, system views
• Mobile Admin — Mobile PWA at /m

Integrations

• GitHub PAT Setup — Personal Access Token configuration for GitHub features
• GitHub Sync — Source mode, working branch mode, branch selection
• Slack Integration — Multi-agent channels, DMs, thread routing
• Telegram Integration — Bot setup, group chats, privacy mode, trigger modes
• WhatsApp Integration — Twilio binding, sandbox setup, email verification
• MCP Server — 100+ MCP tools, API keys, dedicated per-agent tools
• A2A Agent Card — A2A v1.0 discovery for external orchestrators
• Nevermined Payments — x402 payment monetization

CLI

• Trinity CLI — Command-line agent management, multi-instance profiles, deployment

Abilities (Agent Development Toolkit)

• Overview — Plugin marketplace introduction, quick start
• create-agent Plugin — Agent creation wizards (14 wizards)
• agent-dev Plugin — Development tools, memory systems, git sync, backlog cycle, pipelines
• trinity Plugin — Platform deployment, sync, remote loops, instance provisioning
• dev-methodology Plugin — Documentation-driven development
• utilities Plugin — Ops and productivity tools

Dev Announcements

• Dev Announcements — Timestamped archive of all /announce messages sent to Discord and Slack

Advanced

• Voice Chat — Real-time voice via Gemini Live API
• Voice Replies — Agents speak individual channel replies as voice notes (ElevenLabs TTS)
• VoIP Telephony — Agents place outbound phone calls via Twilio + Gemini Live
• Image Generation — Gemini two-step image pipeline
• Agent Avatars — AI-generated avatars, emotion variants
• Dynamic Dashboards — Custom agent dashboards via YAML

API Reference

• Authentication — JWT tokens, API keys, auth flows
• Agent API — Agent CRUD, lifecycle, configuration endpoints
• Chat API — Chat, voice, streaming, public/paid endpoints
• Webhook Triggers — Internal triggers, event webhooks