Documentation

This directory is the user-facing product documentation set. It complements the root release README with task-oriented guides.

Read First#

1. Quickstart - install, configure, run, and open the Web UI.
2. Use Cases and Recipes - task-oriented recipes for common goals.
3. Gateway - gateway lifecycle, host/port, safety, and status.
4. Configuration - provider, router, search, channel, memory, and permission configuration.
5. CLI Reference - command groups and common CLI workflows.
6. Web UI - local control console and chat UI.
7. Sessions and History - session continuity, export, resume, abort, cleanup, and projects (session groups with shared knowledge).
8. Glossary - user-facing terminology.

Feature Guides#

• Feature Catalog - capability catalog.
• Agentic Trading - trading connections, bundled trading skills, and the safety model.
• Pilot Router - model routing.
• Tool Compression - compact tool results and handles.
• Memory - durable memory and recall.
• Skills - skill discovery, install, and authoring.
• Browser automation - browser automation and Chrome attachment.
• Compaction and Cache Continuity - long-session compaction and prompt-cache continuity.
• Browser automation - browser automation: navigate, click, type, screenshot, and JavaScript execution via Chromium.

Surfaces and Operations#

• Channels - supported messaging channels and setup flow.
• Providers and Models - LLM provider catalog, model selection, and runtime-backed model inspection.
• Web Search - web search providers and query workflow.
• X (Twitter) Search - xAI-backed X (Twitter) search: setup, credentials, and reading the degraded flag.
• Artifacts and Media - artifacts, generated files, images, PDF, and TTS.
• Tools, Approvals, and Sandbox - built-in tools, approvals, sandbox posture, and write policy.
• Approvals and Permissions - permission profiles, approval commands, workspace containment, and sandbox posture.
• Durable Agents - durable named agents and workspace defaults.
• Scheduling - recurring and one-time scheduled work.
• HTTP API - REST HTTP API and WebSocket surface for external apps and automation.
• MCP Server Bridge - MCP server bridge for MCP-capable clients.
• Usage and Cost - token usage, estimated cost, and cost investigation workflow.
• Diagnostics and Replay - diagnostics, raw capture guidance, and read-only turn replay.
• Operations - sessions, cron, usage, diagnostics, migration, MCP server, and install inventory commands.
• Troubleshooting - common install/runtime issues.
• Glossary - short definitions for product terms.

Design Principle#

AgentOS documentation should help users run the product first, then understand its special advantages. Mechanism-heavy runtime detail belongs in developer design notes or source comments, not in the first-run path.