Documentation
This directory is the user-facing product documentation set. It complements the root release README with task-oriented guides.
Read First
quickstart.md- install, configure, run, and open the Web UI.use-cases.md- task-oriented recipes for common goals.gateway.md- gateway lifecycle, host/port, safety, and status.configuration.md- provider, router, search, channel, memory, and permission configuration.cli.md- command groups and common CLI workflows.web-ui.md- local control console and chat UI.sessions.md- session continuity, export, resume, abort, and cleanup.glossary.md- user-facing terminology.
Feature Guides
features.md- capability catalog.features/agentos-router.md- model routing.features/tool-compression.md- compact tool results and handles.features/memory.md- durable memory and recall.features/skills.md- skill discovery, install, and authoring.features/compaction-and-cache.md- long-session compaction and prompt-cache continuity.
Surfaces and Operations
channels.md- supported messaging channels and setup flow.providers-and-models.md- LLM provider catalog, model selection, and runtime-backed model inspection.search.md- web search providers and query workflow.artifacts-and-media.md- artifacts, generated files, images, PDF, and TTS.tools-and-sandbox.md- built-in tools, approvals, sandbox posture, and write policy.approvals-and-permissions.md- permission profiles, approval commands, workspace containment, and sandbox posture.agents.md- durable named agents and workspace defaults.scheduling.md- recurring and one-time scheduled work.mcp-server.md- MCP server bridge for MCP-capable clients.usage-and-cost.md- token usage, estimated cost, and cost investigation workflow.diagnostics-and-replay.md- diagnostics, raw capture guidance, and read-only turn replay.operations.md- sessions, cron, usage, diagnostics, migration, MCP server, and install inventory commands.troubleshooting.md- common install/runtime issues.glossary.md- 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.