Skip to content
Docs · Quickstart

DocsGet started

Quickstart

ArcRoom is a team playbook for your AI agents, so they never redo work. Answers, steps that worked and decisions are kept in one place. Every agent reads it before it works and writes to it when it finishes. It works with the agents you already use (Claude Code, Codex, Cursor or OpenCode); any other MCP agent uses its tools, and your own code uses the HTTP API. Set it up once per project, then use your agent as usual.

Before you start

Node.js 20 or later · macOS, Linux or Windows · Claude Code, Codex, Cursor or OpenCode, or any agent that can start an MCP server.

1. Make a key

Create an account, then go to Settings → API keys → Create key. A key is shown once and belongs to you. You can revoke it there at any time.

2. Install in your project

Run it in the project folder and paste the key when it asks. Don't put the key in the command: it would stay in your shell history. It sets ArcRoom up for Claude Code, registers its tools for you only, and starts a small background process that uploads events.

To turn your CLAUDE.md, AGENTS.md and Cursor rules into rules every agent follows, run npx arcroom import. Each file becomes a card on the Rules page, and nothing reaches an agent until a person accepts it there. Add --dry-run first to see the list; your files are never changed.

3. Add your other agents

Use --agent cursor or --agent opencode for those. All of them share one team playbook.

  • Codex: trust the project in Codex, then approve ArcRoom once with Codex's /hooks command.
  • Cursor: restart Cursor. Memory reaches the agent with its first tool call of each turn.
  • OpenCode: restart OpenCode. Support is experimental: recall uses an OpenCode feature that OpenCode marks as experimental.

The full list is on Agent support.

4. Work as usual

Run your agent in that folder. Each session appears on your Overview within seconds, and finished work is offered to the next agent. To check which key and workspace a laptop uses:

5. Bring your team in

A workspace owner makes an invite in Settings → Members. Send the code to the person directly; they enter it when they create their account. A code works once, for 7 days.

Commands

If arcroom isn't on your PATH, run any of these as npx arcroom ….

arcroom init [--agent claude|codex|cursor|opencode]set up this laptop and project
arcroom init --everywherealso cover every other clone and worktree of the repos you set up (Claude Code)
arcroom whoamiwhich key and workspace this laptop uses
arcroom doctorcheck the key, the API and the setup in this folder, with fixes
arcroom off | onArcRoom off or on for this repo, on this laptop
arcroom checks [approve <code>]read and approve this folder’s done-checks
arcroom wrong [memo id] [reason]report a memory that was wrong; with no id, it lists the memories the last hand-over gave so you can pick one
arcroom share <answer id>share an answer you saved as private with your team (or press Share with team on the Memory page)
arcroom decide "<choice>"save a team decision (--why, --over "A, B")
arcroom loginsave and check your key without setting up a project
arcroom init --memory procedures,ruleschoose what this project keeps
arcroom init --desk <id>send this folder's saves and lookups to one desk
arcroom import [--dry-run] [--mine] [--again]turn your CLAUDE.md, AGENTS.md and Cursor rules into cards on the Rules page; --dry-run shows the list and sends nothing, --mine keeps them yours, --again resends unchanged files
arcroom why <file>the team's decisions about a file: what was chosen, why, and what was dropped
arcroom handed [--last N]what your agent was given at session start and before each prompt (kept 7 days on this laptop)
arcroom open on | offshow or hide teammates' open work at session start, for the whole repo
arcroom rule [--tag t] [--max-hits n] [--idle-days d]owners: set an expiry limit for old answers (no limits removes it). Not your agent rules.
arcroom code [status|sync|on|off]see, sync or turn off the code map for this repo (see How recall works)
arcroom sent [YYYY-MM-DD] [--all]what this laptop sent (kept 7 days)
arcroom flushsend what is queued now (end of a CI job)
arcroom uninstall [--all]take ArcRoom out of this repo (--all: also ~/.arcroom)