Docs
How Realm works, from the first install to a team of agents running on a clock. Written for Realm 2.4.
New to Realm? Getting started
The window
- The rail
- Home, the Library, Connections, Scheduled tasks and Code review, with your profile and Settings at its foot.
- The sidebar
- Needs you at the top, then every space with its sessions. A space is one project.
- A session
- One conversation with one agent, and the prompter you talk to it through.
- The side panel
- What the session works with: documents, a terminal, a browser, its sub-agents, a device.
Start here
Work with agents
- Spaces and worktreesA space is one project: its folder, its sessions, its memory and its connections. Worktrees give a session a checkout of its own, so agents working at once don't edit the same files.
- Sessions and the prompterA session is one conversation with one agent. The prompter under it is where you pick the model, the effort and the mode, attach files, set a goal, and line up what to say next.
- Permissions and Full accessWhat an agent may do without asking you, how to answer when it asks, what Full access changes and what it never does, and the sandbox a space can put its agents in.
- Sub-agentsA session's agent can hand parts of its work to sub-agents, on its own model or any other you have, and you can watch, answer and steer each one from the session's Agents tab.
- Teams and ReviewA team gives a space standing teammates: agents with a brief, a model, a clock and a budget, each one a chat you can message. Their work comes to Review, and nothing leaves Realm until you approve it.
- Scheduled tasksRealm can start an agent in one of your spaces on a clock you set, once or on repeat, and keeps every run on the Scheduled page to read and carry on.
Beside the session
- The browserRealm has a browser built into the side panel, signed in per profile, with a password manager your agents can use without ever seeing a password.
- Documents and LibraryRead and write files beside the session that made them, ask about any file where you're looking at it, and find everything your agents ever wrote or were given in the Library.
- TerminalsReal shells in your space's folder, beside the session, and a terminal for each session that you and its agent can both use.
- Code reviewReview your own changes before they leave the session, and read, review and answer GitHub pull requests with any agent, signed in through your own GitHub CLI.
- Computer use and LayaLet an agent use the other apps on your Mac, one app and one space at a time, and run Laya, a model on your Mac that is asked about each step an agent takes there.
- Simulators and devicesOpen an iOS simulator, an Android emulator or a real iPhone in the side panel, use it with the mouse, and let your agent tap through your app and read its screen.
Extend Realm
- Connections and skillsGive a space's agents your apps and tools through one MCP gateway that keeps your credentials out of their hands, and teach them how you work with skills.
- MobileRealm runs on your Mac. This is how to pair an iPhone with it, how it reaches your phone, how to leave agents working while you're away, and how to build mobile apps with it.
Reference
- Settings, themes and shortcutsWhat each page of Settings holds, how to make Realm look the way you want, and every keyboard shortcut, with how to change them.
- Privacy and your dataRealm runs on your computer and keeps its data in one folder there. This is what it stores, where, what leaves your computer and why, and how your credentials are kept from your agents.
- Troubleshooting and FAQWhat Realm's messages mean and what to do about them, and the questions people ask most.