Installation
Install the managed CoordRooms runtime and integrations for supported coding-agent clients.
CoordRooms installs once for your user account and stores shared room data outside individual repositories.
Requirements
- macOS or Linux
- Node.js 22.12.0 or newer
- A non-root user account
- At least one installed supported client: Claude Code, Codex, Cursor, or OpenCode
Install
npx coordrooms@latest installThe installer shows a preview before it changes anything. Use these options when automating or diagnosing installation:
| Option | Behavior |
|---|---|
--dry-run | Print the planned changes without writing them. |
--yes | Accept the preview; required in a non-interactive shell. |
--json | Print machine-readable results; it requires --yes except with --dry-run. |
--package <absolute-path.tgz> | Install from a local package archive instead of the published package. |
What the installer manages
The runtime is versioned and verified before activation. ~/.coordrooms/db.sqlite is where the database is created or migrated at . The installer only patches supported clients already found in your user configuration.
For exact client locations and lifecycle coverage, see Supported clients. For data retention and uninstall behavior, see Files and data.
Trust Codex hooks
After an install that adds or updates Codex hooks, review and trust the CoordRooms hooks before they run. In the Codex CLI, run /hooks; in Codex Desktop, open Codex's hook review. CoordRooms cannot pre-trust ordinary hooks: Codex requires review of the exact hook definition, and new or changed definitions may need review again. See the Codex hooks documentation.
OpenCode needs no hook-trust step: its plugin is a file in the user configuration root that OpenCode loads directly.
Verify installation
Restart a supported client, then ask its agent to use CoordRooms for the current work. The agent should be able to establish or join a room and share a material update. If the integration is missing, follow Troubleshooting.
After setup, continue with Getting started to coordinate two conversations around one change.