# Install Waggle

Waggle is local graph memory for coding agents.

Use it to give Claude, Cursor, Codex, Copilot, and other MCP agents persistent repo memory.

No cloud account. No API key. Local by default.

## Install methods

- [VS Code](./vscode.md)
- [Smithery](./smithery.md)
- [Claude Code](./claude-code.md)
- [Claude Desktop](./claude-desktop.md)
- [Codex](./codex.md)
- [Codex marketplace release checklist](./codex-marketplace-release-checklist.md)
- [Cursor](./cursor.md)
- [Antigravity](./antigravity.md)
- [Generic MCP clients](./generic-mcp.md)
- [Troubleshooting](./troubleshooting.md)
- [Windows setup & troubleshooting](./troubleshooting.md#windows-specific-troubleshooting)

## Client support matrix

| Client              | Method                   | Config location                   |
| ------------------- | ------------------------ | --------------------------------- |
| VS Code             | Extension / Manual       | `.vscode/mcp.json`                |
| Claude Code         | CLI Add / Manual JSON    | Claude Code MCP configuration     |
| Claude Desktop      | `setup --yes` / Manual   | `claude_desktop_config.json`      |
| Cursor              | `setup --yes` / Manual   | `~/.cursor/mcp.json`              |
| Codex               | `setup --yes` / Manual   | `~/.codex/config.toml`            |
| Smithery            | Manual stdio config      | `smithery.yaml`                   |
| Antigravity         | `setup --yes` / Manual   | Generic stdio MCP configuration   |
| Generic MCP Clients | Manual JSON stdio config | Client-specific MCP configuration |


## One-line install

For Cursor, Antigravity, Claude, generic MCP clients, and direct Codex CLI
configuration:

```bash
pipx install waggle-mcp
pipx ensurepath
```

Restart the terminal after the first `pipx ensurepath`, then run:

```bash
waggle-mcp doctor
```

The Codex app plugin bundles a plugin-local server runtime and does not require
a separate PyPI installation.

## Universal stdio config

```json
{
  "mcpServers": {
    "waggle": {
      "command": "waggle-mcp",
      "args": ["serve", "--transport", "stdio"]
    }
  }
}
```

## Verify

```bash
waggle-mcp doctor
waggle-mcp serve --transport stdio
```

## Final checklist

- `waggle-mcp` is on your `PATH`
- `waggle-mcp doctor` reports a writable database path
- Your client config points to `waggle-mcp serve --transport stdio`
- `WAGGLE_DB_PATH` and `WAGGLE_DEFAULT_TENANT_ID` are set if you want non-default storage or tenancy
- The client shows Waggle tools after reload or restart