Roost documentation#

Roost gives your AI agents a place to keep working. Each agent has its own purpose, conversation, files, and memory. You run Roost on your own host and connect it to Codex.

Start here#

• Choose a deployment platform — start with exe.dev, or find the right path for your host.
• Read with an agent — plain Markdown, llms.txt, and a deployment prompt.
• Getting started — connect Codex and create your first agent.
• Install and operate Roost — Linux installation, private access, updates, and recovery.
• Agents and memory — shape an agent's behavior and understand what persists between conversations.

Work with your agents#

• Automations — recurring work, timezones, quiet updates, and run history.
• Delegation — let agents hand a focused task to a specialist.
• Files and approvals — upload inputs, download results, and review actions that need your permission.
• Dashboards — keep saved trackers, notes, and charts outside chat.
• Shared computer — watch browser work and take control of the desktop.
• Push notifications — receive results and approval requests on your devices.
• Mobile access — add Roost to your home screen.

Build and operate#

• Development — run from source, contribution conventions, and packaging.
• Public websites — build and host the marketing and documentation sites separately.
• Architecture — application structure, Codex integration, and storage.
• Remote desktop setup — provision a persistent Linux desktop.
• Conversation performance and PWA startup — implementation notes and measured results.

Deployment model#

Roost is a single-user app. The packaged server listens on loopback and has no application-level authentication. Use an SSH tunnel or a reverse proxy that authenticates both HTTP and WebSocket connections. Its public marketing and documentation sites can be hosted separately from this private app.

Work runs on the server, so closing a browser does not stop it. Roost and its host must stay running for scheduled tasks and notifications. Agent memory and sessions are stored separately, while the operating-system account, connected accounts, and configured desktop are shared.