Admiral knowledge base
Admiral is a native control station for coding agents. The agents run on your machines. Admiral starts them, shows their work live, holds your messages in a queue, and shows the changes they make.
This knowledge base tells you what Admiral does and how to use it. It does not cover source code or system design.
Read in this order
Start
New to Admiral? Read the first three pages in order. Testers also read the fourth.
| Page | What it covers |
|---|---|
| What is Admiral | The product in plain words, and what it is not. |
| Quickstart | Your first session, in five minutes. |
| The main window | A tour of the sidebar, transcript, composer, changes pane, and terminal drawer. |
| The tester program | What testers get, how to join, and what data testers can share. |
Guides
One page per task.
| Page | What it covers |
|---|---|
| Start a session | Pick a project, agent, and branch, then send a prompt. |
| Steer and queue | Send, Queue, Stop, and answering agent questions. |
| Review changes | Read the diff an agent produced. |
| Use terminals | Run commands next to your session. |
| Attachments and output files | Give agents images, and open the files agents make. |
| Import OpenCode sessions | Bring existing OpenCode sessions into a project. |
| Switch agents and models | Change agent or model mid-session, and what carries over. |
| Connect another device | Sign in, sync, and drive a session from your phone. |
| Run a headless engine | Keep agents working on an always-on machine. |
| Run child agents | Let an agent delegate to child sessions. |
| Drive mobile simulators | Let agents test on iOS simulators and Android emulators. |
| Let an agent use the browser and terminal | Agents open tabs and terminals in your session, and you watch them. |
| Search sessions | Find old work across projects and devices. |
Concepts
How the system works, in plain words.
| Page | What it covers |
|---|---|
| Projects and sessions | The two units of organization, and who runs the work. |
| Agents and models | Which agents Admiral runs, and how switching works. |
| Where your data lives | Local-first storage, profiles, and sync. |
| Session states | The status colors and labels in the interface. |
Reference
| Page | What it covers |
|---|---|
| Command line | Every admiral command. |
| Settings pages | What each settings page controls. |
| Keyboard shortcuts | Default keys and how to change them. |
| Themes | Hull, Deck, and custom themes. |
| Glossary | The words this knowledge base uses. |
Support
| Page | What it covers |
|---|---|
| FAQ | Short answers to common questions. |
| Troubleshooting | Known problems and their fixes. |
Conventions
- Project means a folder on one device. Session means one conversation. See the glossary.
- Steps in a guide use the words you see in the app.
- Each page ends with Next steps links.