> ## Documentation Index
> Fetch the complete documentation index at: https://docs.enagrams.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get your team's agents coordinating in under two minutes

## Prerequisites

* Node.js 18+
* An AI coding IDE (Cursor, Claude Code, Codex, or any client with Model Context Protocol support)

## Install

From the root of the repository you want to coordinate:

```bash theme={null}
npx enagrams init
```

That single command:

1. Opens your browser for authentication — no manual API keys to copy
2. Creates the workspace (or joins yours if one exists for this slug)
3. Writes the global API key to `~/.config/enagrams/config.json`
4. Writes the workspace slug to `.env` (`ENAGRAMS_WORKSPACE=...`)
5. Drops IDE configs for Cursor (`.cursor/hooks.json`, `.cursor/mcp.json`), Claude Code (`.mcp.json`, `.claude/settings.json`), and Codex (`.codex/hooks.json`)
6. Installs the hook script at `.cursor/hooks/enagrams-hooks.mjs`
7. Offers to install `enagrams` globally so you can drop `npx`

Reopen your IDE after init so the MCP server and hooks are picked up.

<Note>
  The first `init` on a new machine triggers a browser-based device code flow. Subsequent `init`s in other repos reuse your saved API key automatically.
</Note>

## Verify

```bash theme={null}
enagrams status
```

You should see your workspace name and — once your IDE is open — an active agent session.

## Join an Existing Workspace

If a teammate already created the workspace:

```bash theme={null}
npx enagrams join
```

Pick the workspace from the list. The same config files are written for the current repo.

## What's Installed

| File                                                      | Purpose                                                 |
| --------------------------------------------------------- | ------------------------------------------------------- |
| `~/.config/enagrams/config.json`                          | API key (global, like `gh` / `vercel`)                  |
| `.env`                                                    | `ENAGRAMS_WORKSPACE=<slug>` for this repo               |
| `.cursor/mcp.json`                                        | MCP server config for Cursor                            |
| `.cursor/hooks.json` + `.cursor/hooks/enagrams-hooks.mjs` | Cursor event hooks                                      |
| `.mcp.json`                                               | MCP server config for Claude Code                       |
| `.claude/settings.json`                                   | Claude Code hook config (reuses the Cursor hook script) |
| `.codex/hooks.json`                                       | Codex hook config                                       |

All configs point to the same hook script, so every agent in every IDE on your machine emits activity to the same workspace.

## Your First Coordinated Edit

<Steps>
  <Step title="Open your IDE">
    Cursor, Claude Code, or Codex. The `sessionStart` hook fires, your session is registered, and you'll see a team briefing in the hook output.
  </Step>

  <Step title="Have your agent read and edit a file">
    On the first write, the `preToolUse` hook calls `file_lock` so you own that file until your session ends or your agent runs `session_end`.
  </Step>

  <Step title="Ask a teammate to edit the same file">
    Their agent's `preToolUse` hook is denied with a message telling them who owns it and what you're working on. They route around.
  </Step>

  <Step title="Make an architectural choice">
    Call the `decide` MCP tool from your agent. Every teammate's next `sync` surfaces the decision immediately.
  </Step>
</Steps>

## Next Steps

<CardGroup cols={2}>
  <Card title="How Enagrams works" icon="gear" href="/guides/how-it-works">
    The coordination model from hooks to sync.
  </Card>

  <Card title="All 24 MCP tools" icon="plug" href="/mcp/overview">
    Every tool your agents can call.
  </Card>

  <Card title="IDE setup guides" icon="terminal" href="/guides/cursor-setup">
    Cursor, Claude Code, and Codex specifics.
  </Card>

  <Card title="CLI reference" icon="square-terminal" href="/guides/cli-reference">
    Every `enagrams` command.
  </Card>
</CardGroup>