---
title: "Docs"
description: "Guides to OpenAgents: the chat, Coder, the apps, plugins, and the Gym."
url: "https://openagents.com/docs"
---

# Docs

Guides to OpenAgents: the chat, Coder, the apps, plugins, and the Gym.

## Getting started

What OpenAgents is, and how to get it.

- [What is OpenAgents](/docs/what-is-openagents.md): OpenAgents is an open network of agents you work with through one conversation, from anywhere: this website, your phone, or a terminal. Ask a question, plan some work, or ask for a code change, and…
- [Download](/docs/download.md): The download page has Coder's install commands for seven platforms, the iPhone beta, and a link to the web app.

## Apps

The website, the Mac and iPhone apps, the Terminal, and the command.

- [Chat on openagents.com](/docs/website.md): The homepage has a message box. Type what you want to ask and send it. The site opens a new chat at an address under /chat/.
- [OpenAgents for Mac](/docs/mac.md): OpenAgents for Mac is where you chat with OpenAgents on your computer, run Coder in your projects, and connect your phone to the Mac. It isn't published for download yet; build it from source. To use…
- [OpenAgents for iPhone](/docs/iphone.md): OpenAgents for iPhone lets you chat with OpenAgents anywhere and send coding work to your computers. It's in beta on TestFlight: install TestFlight from the App Store, then open…
- [OpenAgents Terminal](/docs/terminal.md): OpenAgents Terminal is a full-screen chat with OpenAgents in your terminal. When a message is coding work, Coder runs on this computer, in the folder you started from, and its steps stream into the…
- [The openagents command](/docs/cli.md): openagents is the command-line program behind OpenAgents Terminal. Use it to chat from a script, change Coder's settings, work with plugins, and connect phones to a computer without a screen. It…

## Chat

What the chat answers, and who sees your messages.

- [Chat](/docs/chat.md): Chat is where you talk with OpenAgents. It's the same chat on the website, the Mac app, the iPhone app, and the Terminal. OpenAgents answers as "we".
- [Privacy and security](/docs/privacy-and-security.md): No account needed. The apps have no account or password. Your phone or computer makes its own key the first time it runs and signs every message with it. On the website, the site signs your messages…

## Coder

Coding work on your own computer, with the agents you already use.

- [Coder quick start](/docs/coder.md): Coder is an AI coding assistant in your terminal. Ask it to explain code, change files, or run commands in the folder you open. You can follow its work in the chat and open a delegated agent's…
- [Coding agents](/docs/coding-agents.md): Coder doesn't bring its own model account. It runs the coding agents you already use, on your computer, under your own sign-in with each one.
- [Watch, steer, and stop Coder](/docs/following-coder.md): A Coder run lives in its chat. You can follow it, add to it, answer it, or stop it from the Mac app, the Terminal, the openagents command, or your phone.
- [Traces](/docs/traces.md): A trace is a record of an agent run: what you asked, what the agent said, and each step it took, such as a command it ran, with the result. Coder keeps every chat as one, in the open ATIF format.…
- [Worktrees and changes](/docs/worktrees-and-changes.md): Coder never works in your checkout. Each task gets its own Git worktree: a separate folder with a copy of your project at its last commit. Your files, your branch, and any uncommitted changes stay as…
- [Work on a GitHub issue](/docs/github-issues.md): Ask Coder to work an issue and it takes the issue from claim to close: it reads the issue, does the work, runs your checks, lands the change, and reports on the issue.
- [Ship an iPhone build from your phone](/docs/ship-from-your-phone.md): You can ask Coder, from your phone, to build an iPhone app on your Mac and upload it to TestFlight. Then you install the new build on the same phone. This is how we ship OpenAgents for iPhone: build…

## Computers

Connect a computer to your account or your phone, and manage them.

- [Connect a computer](/docs/connect-a-computer.md): When a computer is connected to your openagents.com account, its Coder chats show on the website, in the left panel, where you can reply to them.
- [Manage computers](/docs/manage-computers.md): Settings lists the computers signed in to your account, each with Remove, which signs it out. To add one, run coder login on it; see Connect a computer.

## Plugins

Make a plugin, test whether it helps, and publish the result.

- [Plugins](/docs/plugins.md): A plugin is anything you add to OpenAgents. You write one, test whether it helps Coder, and publish it so other people can check your result and use it.
- [Write a plugin](/docs/write-a-plugin.md): There are two ways to make a plugin: in chat, or as a directory of files.
- [Test a plugin](/docs/test-a-plugin.md): A test shows whether a plugin helps. Coder does the same tasks twice: once with the plugin and once without it. Each test is a task (a prompt and the files it starts with) and the checks on what the…
- [Publish and share](/docs/publish-and-share.md): Publishing makes a plugin's test result public, so other people can rerun it, build on it, and use the plugin.

## The Gym, the Verse, and the wallet

XP, the shared world, bitcoin, and decks.

- [The Gym and XP](/docs/gym-and-xp.md): The Gym is where plugins are tested on Coder: the same tests with the plugin and without it, so anyone can see whether it helps. It lives in the chat, and its results also stand on boards in the…
- [The Verse](/docs/verse.md): The Verse is a shared world. Its first place is the Grid: a floor of white lines where other players walk around live, with a ball, a stack of blocks, dominoes, and the Gym. There's no chat in the…
- [The Grid](/docs/the-grid.md): The Grid is the OpenAgents Verse world: a floor of white lines with the Gym building, a ball, and scattered blocks, where other players walk around live. The Mac app shows it on its Verse page, and…
- [Wallet](/docs/wallet.md): The iPhone app's Wallet tab is a bitcoin wallet on mainnet, with its keys on your phone. It runs on Breez's Spark SDK. It's real bitcoin, so keep amounts you'd be comfortable carrying in a phone…
- [Decks and the Map](/docs/decks.md): OpenAgents for Mac can show a slide deck full screen, and a map of how OpenAgents routes every message.

## Reference

Settings, pricing, and fixes for common problems.

- [Settings](/docs/settings.md): Coder's settings on a computer live in one file, ~/.openagents/settings.json. The Mac app, OpenAgents Terminal, the openagents command, and the computer's host all read it. With no file, every…
- [Pricing](/docs/pricing.md): Chatting with OpenAgents is free, and so is Coder on your own computer.
- [Troubleshooting](/docs/troubleshooting.md): The Mac app says "Coder isn't answering on this Mac" when its background helper (the host) doesn't answer. The app keeps trying on its own.

## Questions and words

Short answers, and what each word means.

- [FAQ](/docs/faq.md): Chatting with OpenAgents is free, and we don't count your messages. Coder runs on your own computer with the coding agents you already use there, so it doesn't bill you through us; each agent's own…
- [Glossary](/docs/glossary.md): The words these docs use, in plain terms.

## API

- [API docs](/docs/api.md): One API for many models: Open Responses and Chat Completions at `https://api.openagents.com/v1` (also `https://openagents.com/api/v1`). Beta.

## What works and what's next

- [What works today](/promises.md): each thing that works today, with its proof.
- [Roadmap](/roadmap.md): what we're building next.
