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

# Overview

> Connect ByteRover to your AI coding agents

Coding agent connectors integrate ByteRover's context tree with your AI coding agents.
When connected, your coding agent gains access to ByteRover's context tree through direct tool integration (`brv-query`, `brv-curate`) or CLI commands (`brv query`, `brv curate`).

<Tip>
  Prefer a visual workflow? See [Configuration in the web UI](/local-web-ui/configuration).
</Tip>

## Connector types

ByteRover supports four connector types:

<CardGroup cols={2}>
  <Card title="Skill Connector" icon="zap">
    Drops ByteRover skill files into your project that agents pick up automatically.
  </Card>

  <Card title="MCP Connector" icon="plug-zap">
    Gives your agent `brv-query` and `brv-curate` tools directly.
  </Card>

  <Card title="Rules Connector" icon="file-check">
    Adds a rules file (e.g., `CLAUDE.md`) your agent reads on startup.
  </Card>

  <Card title="Hook Connector" icon="webhook">
    Injects ByteRover instructions into every prompt automatically.
  </Card>
</CardGroup>

<Note>
  **Skill is the default connector** for most agents, providing comprehensive
  project-level guidance. **MCP is the default** for Augment Code, Claude Desktop,
  Cline, Qwen Code, and Zed.
</Note>

## Connect an agent

<Tabs>
  <Tab title="TUI">
    Run `/connectors` in the interactive TUI to open the connector manager:

    ```
    /connectors
    ```

    <img src="https://mintcdn.com/demo-a750c123/_FRua5ur0UwwoNUe/images/v2_quickStart_connectors.png?fit=max&auto=format&n=_FRua5ur0UwwoNUe&q=85&s=699922c82ed7e012bb37a51bb3e99a83" alt="Connector manager" width="700" style={{ borderRadius: '12px' }} data-path="images/v2_quickStart_connectors.png" />

    **Interactive flow:**

    1. **Detect** — Scans for currently installed connectors
    2. **Select** — Choose to manage an existing connector or connect a new agent
    3. **Configure** — Pick your agent and connector type
    4. **Install** — Creates the config file, rule file, or skill files automatically
  </Tab>

  <Tab title="CLI">
    Install the default connector for an agent:

    ```bash theme={null}
    brv connectors install "Claude Code"
    ```

    Install a specific connector type with `--type` (or `-t`):

    ```bash theme={null}
    brv connectors install "Claude Code" --type mcp
    brv connectors install Cursor --type rules
    ```

    List all installed connectors:

    ```bash theme={null}
    brv connectors list
    ```
  </Tab>
</Tabs>

<Note>
  **MCP connectors**: Some agents support auto-setup where ByteRover writes the config file automatically. Others require manual configuration — ByteRover will display the steps.

  **Hook connectors**: Restart your coding agent after installation to apply the new hooks.

  **Skill connectors**: Re-run `brv connectors install <agent>` after upgrading the CLI to pick up skill template updates.
</Note>

## Supported agents

ByteRover supports 24 AI coding agents. Skill is the default for most agents; MCP is the default for Augment Code, Claude Desktop, Cline, Qwen Code, and Zed:

| Agent          | Category    | Default | Supported               | Skills Directory              |
| -------------- | ----------- | ------- | ----------------------- | ----------------------------- |
| Antigravity    | AI IDE      | Skill   | rules, mcp, skill       | `.agent/skills/byterover/`    |
| Cursor         | AI IDE      | Skill   | rules, mcp, skill       | `.cursor/skills/byterover/`   |
| Windsurf       | AI IDE      | Skill   | rules, mcp, skill       | `.windsurf/skills/byterover/` |
| Qoder          | AI IDE      | Skill   | rules, mcp, skill       | `.qoder/skills/byterover/`    |
| Zed            | AI IDE      | MCP     | rules, mcp              | -                             |
| Trae.ai        | AI IDE      | Skill   | rules, mcp, skill       | `.trae/skills/byterover/`     |
| Claude Desktop | Desktop App | MCP     | mcp                     | -                             |
| Claude Code    | CLI Tool    | Skill   | rules, hook, mcp, skill | `.claude/skills/byterover/`   |
| Auggie CLI     | CLI Tool    | Skill   | rules, mcp, skill       | `.augment/skills/byterover/`  |
| Gemini CLI     | CLI Tool    | Skill   | rules, mcp, skill       | `.gemini/skills/byterover/`   |
| Codex          | CLI Tool    | Skill   | rules, mcp, skill       | `.agents/skills/byterover/`   |
| OpenClaude     | CLI Tool    | Skill   | rules, mcp, skill       | `.claude/skills/byterover/`   |
| OpenClaw       | CLI Tool    | Skill   | skill                   | -                             |
| OpenCode       | CLI Tool    | Skill   | rules, mcp, skill       | `.opencode/skills/byterover/` |
| Qwen Code      | CLI Tool    | MCP     | rules, mcp              | -                             |
| Warp           | CLI Tool    | Skill   | rules, mcp, skill       | `.warp/skills/byterover/`     |
| Cline          | VS Code     | MCP     | rules, mcp              | -                             |
| GitHub Copilot | VS Code     | Skill   | rules, mcp, skill       | `.github/skills/byterover/`   |
| Kilo Code      | VS Code     | Skill   | rules, mcp, skill       | `.kilocode/skills/byterover/` |
| Roo Code       | VS Code     | Skill   | rules, mcp, skill       | `.roo/skills/byterover/`      |
| Augment Code   | VS Code     | MCP     | rules, mcp              | -                             |
| Amp            | VS Code     | Skill   | rules, mcp, skill       | `.agents/skills/byterover/`   |
| Kiro           | VS Code     | Skill   | rules, mcp, skill       | `.kiro/skills/byterover/`     |
| Junie          | VS Code     | Skill   | rules, mcp, skill       | `.junie/skills/byterover/`    |

For agents that support **Skill** connectors, you can also install additional community agent skills from [BRV Hub](/brv-hub/overview):

```bash theme={null}
brv hub install byterover-review --agent "Claude Code"
```

<Tip>
  Learn more about alternative OpenClaw integrations in the [documentation](https://docs.byterover.dev/autonomous-agents/openclaw).
</Tip>

## Next steps

Choose your coding agent category to see detailed setup instructions:

<CardGroup cols={3}>
  <Card title="AI-Powered IDEs" icon="sparkles" href="/connectors/ai-ides">
    Antigravity, Cursor, Windsurf, Qoder, Zed, Trae.ai
  </Card>

  <Card title="CLI Tools" icon="terminal" href="/connectors/cli-tools">
    Claude Code, Auggie CLI, Gemini CLI, Codex, OpenClaude, OpenCode, Qwen Code, Warp
  </Card>

  <Card title="Desktop Apps" icon="monitor" href="/connectors/desktop-apps">
    Claude Desktop
  </Card>

  <Card title="VS Code Extensions" icon="plug" href="/connectors/vscode-extensions">
    Cline, Copilot, Kilo, Roo, Augment, Amp, Kiro, Junie
  </Card>
</CardGroup>