OAR documentation

OAR is a self-hosted relay that lets you drive the coding agents on your own machine from any browser. These pages explain how it works and give the exact reference for its commands, settings and agent tools.

Start here #

• Install: put the oar command on your machine.
• First run: set up, start the relay and sign in.
• Providers at a glance: the agents OAR can run and what each needs.
• Starting a conversation: the New chat dialog, field by field.
• Agents working together: agents that start, message and watch each other.
• Troubleshooting: first steps and fixes by symptom.

Sections #

• Getting startedInstall OAR, start the relay, open it in your browser and keep it running — from the first command to the first conversation.
• ProvidersThe eight agents OAR can run — GitHub Copilot, OpenAI (with OpenAI Image), Claude, Claude API, Claude Cloud, Cursor, Grok and DeepSeek — how to set each one up and how they differ.
• SessionsConversations in OAR from start to finish — starting one, relay modes, turns and the queue, restarts, the list and its session groups, archiving and compacting.
• In a conversationWorking with an agent in OAR — following a turn, steering it, answering questions, plans, background work, the composer and the transcript.
• Files and previewsBrowsing the workspace from OAR, viewing files, reviewing git changes, and publishing a web preview of what an agent built.
• Agents working togetherHow agents in OAR work with other sessions — handing off parts of a task on one relay, across paired relays, and watching sessions.
• Usage and contextWhat your provider plans and balances have left, how full a conversation's context window is, and what OAR shows about both.
• DevicesUsing OAR from a phone or a second computer — installing it as an app, push notifications, appearance, and suspending the host.
• Remote access and securityReaching your relay from outside your network — the access token, tunnels and reverse proxies — and what is exposed when you do.
• UpdatesHow a relay learns of a new OAR release and installs it - the opt-in update check, the Update button, oar update, channels, and what an update leaves alone.
• ReferenceExact lookup material for OAR — the tools it gives agents, with every action, parameter, limit and error.
• TroubleshootingWhere to start when OAR does not work - oar status and oar doctor, the logs, restarting a session or the relay, and a table that leads from a symptom to its fix.

About these pages #

• They describe the latest release, shown beside Docs in the top bar. A badge such as Added in 0.9.10 marks where something arrived.
• OAR runs agents from eight providers: GitHub Copilot, OpenAI (with OpenAI Image), Claude, Claude API, Claude Cloud, Cursor, Grok and DeepSeek. Pages describe what is the same for all of them and carry a By provider table where they differ.
• Names of buttons and settings are written as the app shows them, for example Settings → Relays.