--- 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, your first task with Coder, 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… - [Start here](/docs/start-here.md): Your first half hour with Coder, step by step: install it, log in, give it a first task in one of your repositories, read what it did, and answer a step that waits for you. Every command is here to… - [Download and install](/docs/download.md): Coder runs on macOS, Linux, and Windows. One command installs it, and the same command updates it. The download page has the same commands and a manual download for each platform. ## Apps The website, the phone and desktop apps, custom agents, 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 desktop app](/docs/mac.md): The OpenAgents desktop app, for Mac, Linux, and Windows, is coming soon. It isn't published for download yet. When it is, it shows on the download page. - [OpenAgents for iPhone](/docs/iphone.md): OpenAgents for iPhone is the OpenAgents app on your phone. Ask anything, start coding work that runs in our cloud, and connect your own computer when you want to. You don't need a computer or an… - [Custom agents](/docs/custom-agents.md): A custom agent is an agent you define: a name, a description, instructions, and the coding agent it runs on, such as Claude Code or Codex, with an optional model. You save it to your account, and… - [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 that comes with Coder. Use it to run Coder from a script, chat from a script, change settings, work with plugins, and connect phones to a computer without a… ## 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 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 a coding agent in your terminal. Run coder in a project folder and ask in plain words: explain this code, fix that test, add a feature. It reads, edits, and runs commands in that folder, and… - [How Coder works](/docs/coder-how-it-works.md): Coder sits between you and the coding agents you already use. It makes the quick calls itself, sends only the hard part of the work to the big model, and holds the few steps that are hard to undo… - [Use Coder in the terminal](/docs/coder-terminal.md): Run coder in a project folder to open it there. To open it on another folder from where you are: - [Choose who answers](/docs/coder-agents.md): Coder is one chat, whoever answers it. Each chat runs on one of these: - [Coder's plugins](/docs/coder-plugins.md): Coder's abilities come as plugins you can turn on and off. Type /plugins, or press Ctrl+P (Cmd+P on macOS) or F2. - [Solve an issue](/docs/coder-solver.md): Solver takes a GitHub issue to a pull request. It works in its own fresh copy of your project, so your checkout isn't touched, and it opens the pull request only when the checks pass. - [Safety](/docs/coder-safety.md): Coder does ordinary coding work without stopping to ask: reading files, editing them, and running commands such as builds and tests. A short list of actions that are hard to undo always waits for… - [Sync, share, and export](/docs/coder-sync.md): Coder keeps your chats on your computer. Logged in (coder login), it can keep them on your openagents.com account too, so you can read and answer them on the web and on your phone. - [Coder from scripts](/docs/coder-scripts.md): openagents coder runs the same chat as the terminal app, without the screen: for scripts, CI jobs, and other agents. It comes with Coder; see Download and install. Run openagents coder --help for… - [Coding agents](/docs/coding-agents.md): Coder runs the coding agents you already use, on your computer, under your own login with each one. This page covers Coder tasks started from OpenAgents Terminal or openagents chat; for the coder… - [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 Terminal or the openagents command. - [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): A Coder task started from OpenAgents Terminal or openagents chat 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.… - [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. ## Tutorials Step-by-step guides to everyday tasks with Coder and OpenAgents. - [Fix a failing test](/docs/fix-a-failing-test.md): A test fails and you want it fixed, with the cause explained and nothing else changed. This guide takes you from the red test to a change you've read and committed. - [Use your Claude Code or Codex](/docs/use-claude-code-or-codex.md): Already pay for Claude or ChatGPT? Coder runs Claude Code and Codex on your own login, so their work comes out of your plan, not out of anything we charge. You keep one chat, with the same keys… - [Pin a model or use Auto](/docs/pin-a-model.md): Every new chat starts on Auto: Coder looks at your message and picks who answers and on which model. You can pin your own choice instead, for one chat or for every new chat. This guide shows when… - [Queue messages while Coder works](/docs/queue-messages.md): You don't have to wait for Coder to finish before you type. Each message can either go now, changing what Coder is doing, or wait in a queue and go when the current reply ends. This guide shows both… - [Share a project with a teammate](/docs/share-a-project.md): A project on openagents.com groups chats, files, and notes around your work, often a GitHub repository. Share one and your teammate sees the same chats and files, and can add their own. This guide… - [Design a part in CAD Lab](/docs/design-a-part.md): CAD Lab designs parts by talking: say what you want, and it builds the part, checks it, measures it, and keeps every version so you can compare them. This guide makes a small bracket on… - [Follow a run from your phone](/docs/follow-from-your-phone.md): Start a long task in Coder on your computer, walk away, and keep up with it from your phone: read its steps and send a reply that Coder picks up on your computer. This works in your phone's browser… - [Use Coder on Windows](/docs/coder-on-windows.md): Coder, its chats, and the openagents command work on Windows, with the same keys and commands as on macOS and Linux. This guide installs Coder in PowerShell, sets up an agent, and covers what's… - [Export and share a chat](/docs/export-and-share-a-chat.md): Every Coder chat is saved on your computer as you go. You can save one to a file, open it again later or on another computer, or share it with a link. This guide covers all three, and saving a web… ## 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 logged 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, and bitcoin. - [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 you open in your browser, with nothing to install. Its places run on this site: - [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. Open it in your browser at… - [Wallet](/docs/wallet.md): OpenAgents for iPhone has a bitcoin wallet on mainnet, with its keys on your phone. It runs on Spark, through Breez's SDK. It's real bitcoin, so keep amounts you'd be comfortable carrying in a phone… ## Reference Settings, keys, commands, pricing, fixes for common problems, and running your own copy. - [Settings](/docs/settings.md): Coder's settings on a computer live in one file, ~/.openagents/settings.json. OpenAgents Terminal, the openagents command, and the computer's host all read it. With no file, every setting is its… - [Keyboard shortcuts](/docs/keyboard-shortcuts.md): Every key in Coder, in the web chat, and in the screens they open, in one place. Type /help in Coder to see the short list there. - [Slash commands](/docs/slash-commands.md): Commands you type in Coder's input. Type / to see them above the input; keep typing to filter, Tab to complete, and Enter to run one. - [Command reference](/docs/command-reference.md): The commands you run in a terminal, for people rather than scripts. This list comes from the commands' own help: add --help to coder or to openagents GROUP (such as openagents projects --help) for… - [Pricing](/docs/pricing.md): Free is OpenAgents on your own computer: Coder in front of the agents you already use (Claude Code, Codex, OpenCode, Grok Build, Devin CLI, Cursor), running on your own models, keys and… - [Troubleshooting](/docs/troubleshooting.md): Open a new terminal: the installer added ~/.openagents/bin to your PATH, and only new terminals see it. Or run it by its full path, ~/.openagents/bin/coder. If you installed with… - [Run your own OpenAgents](/docs/self-host.md): Everything that runs openagents.com is open source under the Apache 2.0 license, in one repository. You can run your own copy with your own model keys: the website, the account service, the chat… ## 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, such as Claude Code and Codex, and each one'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`. Beta. ## For agents - [Docs for agents](/docs/agents.md): Docs for agents that use OpenAgents, and for the people who build them: sign up, pay in bitcoin, call the API, and use our MCP server and command. ## 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.