> ## 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.

# Command Line Tools

> Connect ByteRover to Claude Code, Gemini CLI, and other CLI-based coding agents

This guide covers connecting ByteRover to command-line coding tools. Most CLI tools use **Skill** as the default connector for comprehensive project-level guidance. All also support **MCP** and **rules**.

## Quick setup

<Tabs>
  <Tab title="TUI">
    Run `/connectors` in the interactive TUI, select your tool, and choose a connector type:

    ```
    /connectors
    ```
  </Tab>

  <Tab title="CLI">
    Install the default connector for your tool:

    ```bash theme={null}
    brv connectors install "Claude Code"
    brv connectors install "Gemini CLI"
    brv connectors install "Auggie CLI"
    brv connectors install "OpenClaude"
    ```

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

    ```bash theme={null}
    brv connectors install "Claude Code" --type mcp
    brv connectors install "Claude Code" --type hook
    ```
  </Tab>
</Tabs>

***

## Claude Code

Claude Code supports **skill** (default), **hook**, **MCP**, and **rules** connectors. Skill provides comprehensive project-level guidance through discoverable markdown files.

<Tabs>
  <Tab title="Skill (Default)">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Claude Code**
        3. Choose **Skill** connector (recommended)
        4. ByteRover creates `.claude/skills/byterover/` with:
           * `SKILL.md` — Quick reference with commands and best practices
           * `WORKFLOWS.md` — Detailed workflow patterns
           * `TROUBLESHOOTING.md` — Diagnostics and support info
        5. **Restart Claude Code** to discover the skill files
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

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

        <Tip>
          Install additional community agent skills from [BRV Hub](/brv-hub/overview):

          ```bash theme={null}
          brv hub install byterover-review --agent "Claude Code"
          ```
        </Tip>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Hook">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Claude Code**
        3. Choose **Hook** connector
        4. **Restart Claude Code** to apply the new hooks
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Claude Code" --type hook
        ```
      </Tab>
    </Tabs>

    <Note>
      When using hooks, ByteRover automatically preserves your existing Claude Code hooks and prevents duplicates.
    </Note>
  </Tab>

  <Tab title="MCP">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Claude Code**
        3. Choose **MCP** connector
        4. ByteRover will configure `.mcp.json` in your project root
        5. **Restart Claude Code** to load the MCP server
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Claude Code" --type mcp
        ```
      </Tab>
    </Tabs>

    <Note>
      MCP provides direct `brv-query` and `brv-curate` tools to Claude Code without requiring hook injection.
    </Note>
  </Tab>

  <Tab title="Rules">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Claude Code**
        3. Choose **Rules** connector
        4. Done — Claude Code will read `CLAUDE.md` automatically
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Claude Code" --type rules
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Details">
    | Property                 | Value                         |
    | ------------------------ | ----------------------------- |
    | **Default connector**    | Skill                         |
    | **Supported connectors** | Skill, Hook, MCP, Rules       |
    | Skill directory          | `.claude/skills/byterover/`   |
    | Rule file                | `CLAUDE.md`                   |
    | MCP config               | `.mcp.json` (auto-setup)      |
    | Hook config              | `.claude/settings.local.json` |
    | Auto-detected            | Yes                           |

    **Connector comparison:**

    * **Skill**: Comprehensive documentation files that Claude Code discovers automatically
    * **Hook**: Instructions injected on every prompt via `brv hook-prompt-submit` command
    * **MCP**: Direct tool integration with `brv-query` and `brv-curate` tools
    * **Rules**: Instructions loaded from `CLAUDE.md` file in project root
  </Tab>
</Tabs>

***

## OpenClaude

OpenClaude is a multi-provider Claude Code fork that reuses Claude Code's config paths (`~/.claude/`, `.mcp.json`, `CLAUDE.md`, `.claude/skills/`). It supports **Skill** (default), **MCP**, and **Rules** connectors.

<Tabs>
  <Tab title="Skill (Default)">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **OpenClaude**
        3. Choose **Skill** connector (recommended)
        4. ByteRover creates `.claude/skills/byterover/` with:
           * `SKILL.md` — Quick reference with commands and best practices
           * `WORKFLOWS.md` — Detailed workflow patterns
           * `TROUBLESHOOTING.md` — Diagnostics and support info
        5. **Restart OpenClaude** to discover the skill files
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "OpenClaude"
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="MCP">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **OpenClaude**
        3. Choose **MCP** connector
        4. ByteRover will configure `.mcp.json` in your project root
        5. **Restart OpenClaude** to load the MCP server
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "OpenClaude" --type mcp
        ```
      </Tab>
    </Tabs>

    <Note>
      MCP provides direct `brv-query` and `brv-curate` tools to OpenClaude without requiring hook injection.
    </Note>
  </Tab>

  <Tab title="Rules">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **OpenClaude**
        3. Choose **Rules** connector
        4. Done — OpenClaude will read `CLAUDE.md` automatically
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "OpenClaude" --type rules
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Details">
    | Property                 | Value                       |
    | ------------------------ | --------------------------- |
    | **Default connector**    | Skill                       |
    | **Supported connectors** | Skill, MCP, Rules           |
    | Skill directory          | `.claude/skills/byterover/` |
    | Rule file                | `CLAUDE.md`                 |
    | MCP config               | `.mcp.json` (auto-setup)    |
    | Auto-detected            | Yes                         |

    <Note>
      OpenClaude shares config paths with Claude Code, so an existing Claude Code connector setup is picked up automatically.
    </Note>
  </Tab>
</Tabs>

***

## Auggie CLI

Auggie CLI uses **Skill** as the default connector for comprehensive project-level guidance.

<Tabs>
  <Tab title="Skill (Default)">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Auggie CLI**
        3. Choose **Skill** connector (recommended)
        4. ByteRover creates `.augment/skills/byterover/` with:
           * `SKILL.md` — Quick reference with commands and best practices
           * `WORKFLOWS.md` — Detailed workflow patterns
           * `TROUBLESHOOTING.md` — Diagnostics and support info
        5. **Restart Auggie CLI** to discover the skill files
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Auggie CLI"
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="MCP">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Auggie CLI**
        3. Choose **MCP** connector
        4. Follow the **manual setup** instructions provided
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Auggie CLI" --type mcp
        ```
      </Tab>
    </Tabs>

    <Warning>
      Auggie CLI requires **manual MCP configuration**. ByteRover will display the configuration steps to follow.
    </Warning>
  </Tab>

  <Tab title="Rules">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Auggie CLI**
        3. Choose **Rules** connector
        4. Done — Auggie CLI will read `.augment/rules/agent-context.md` automatically
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Auggie CLI" --type rules
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Details">
    | Property                 | Value                             |
    | ------------------------ | --------------------------------- |
    | **Default connector**    | Skill                             |
    | **Supported connectors** | Skill, MCP, Rules                 |
    | Skill directory          | `.augment/skills/byterover/`      |
    | Rule file                | `.augment/rules/agent-context.md` |
    | MCP config               | Manual setup                      |
    | Auto-detected            | Yes                               |
  </Tab>
</Tabs>

***

## Gemini CLI

Gemini CLI uses **Skill** as the default connector for comprehensive project-level guidance.

<Tabs>
  <Tab title="Skill (Default)">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Gemini CLI**
        3. Choose **Skill** connector (recommended)
        4. ByteRover creates `.gemini/skills/byterover/` with:
           * `SKILL.md` — Quick reference with commands and best practices
           * `WORKFLOWS.md` — Detailed workflow patterns
           * `TROUBLESHOOTING.md` — Diagnostics and support info
        5. **Restart Gemini CLI** to discover the skill files
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Gemini CLI"
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="MCP">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Gemini CLI**
        3. Choose **MCP** connector
        4. ByteRover will configure `.gemini/settings.json` automatically
        5. **Restart Gemini CLI** to load the MCP server
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Gemini CLI" --type mcp
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Rules">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Gemini CLI**
        3. Choose **Rules** connector
        4. Done — Gemini CLI will read `GEMINI.md` automatically
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Gemini CLI" --type rules
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Details">
    | Property                 | Value                                |
    | ------------------------ | ------------------------------------ |
    | **Default connector**    | Skill                                |
    | **Supported connectors** | Skill, MCP, Rules                    |
    | Skill directory          | `.gemini/skills/byterover/`          |
    | Rule file                | `GEMINI.md`                          |
    | MCP config               | `.gemini/settings.json` (auto-setup) |
    | Auto-detected            | Yes                                  |
  </Tab>
</Tabs>

***

## Codex

Codex uses **Skill** as the default connector, with **MCP** and **rules** as alternatives.

<Tabs>
  <Tab title="Skill (Default)">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Codex**
        3. Choose **Skill** connector (recommended)
        4. ByteRover creates `.agents/skills/byterover/` with:
           * `SKILL.md` — Quick reference with commands and best practices
           * `WORKFLOWS.md` — Detailed workflow patterns
           * `TROUBLESHOOTING.md` — Diagnostics and support info
        5. **Restart Codex** to discover the skill files
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install Codex
        ```

        <Tip>
          Install additional community agent skills from [BRV Hub](/brv-hub/overview):

          ```bash theme={null}
          brv hub install byterover-review --agent Codex
          ```
        </Tip>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="MCP">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Codex**
        3. Choose **MCP** connector
        4. ByteRover will configure `~/.codex/config.toml` automatically
        5. **Restart Codex** to load the MCP server
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install Codex --type mcp
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Rules">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Codex**
        3. Choose **Rules** connector
        4. Done — Codex will read `AGENTS.md` automatically
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install Codex --type rules
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Details">
    | Property                 | Value                                       |
    | ------------------------ | ------------------------------------------- |
    | **Default connector**    | Skill                                       |
    | **Supported connectors** | Skill, MCP, Rules                           |
    | Skill directory          | `.agents/skills/byterover/`                 |
    | Rule file                | `AGENTS.md`                                 |
    | MCP config               | `~/.codex/config.toml` (auto-setup, global) |
    | Auto-detected            | Yes                                         |

    <Warning>
      **Network access required for Codex**

      Codex runs in a sandboxed mode without internet access by default. To use ByteRover:

      1. Switch to **Agent (full access) mode**, OR
      2. Add to your prompt: *"You can ask me about network access and I will allow it"*
      3. Approve network access when prompted
    </Warning>
  </Tab>
</Tabs>

***

## OpenCode

OpenCode uses **Skill** as the default connector for comprehensive project-level guidance.

<Tabs>
  <Tab title="Skill (Default)">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **OpenCode**
        3. Choose **Skill** connector (recommended)
        4. ByteRover creates `.opencode/skills/byterover/` with:
           * `SKILL.md` — Quick reference with commands and best practices
           * `WORKFLOWS.md` — Detailed workflow patterns
           * `TROUBLESHOOTING.md` — Diagnostics and support info
        5. **Restart OpenCode** to discover the skill files
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

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

  <Tab title="MCP">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **OpenCode**
        3. Choose **MCP** connector
        4. Follow the **manual setup** instructions provided
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install OpenCode --type mcp
        ```
      </Tab>
    </Tabs>

    <Warning>
      OpenCode requires **manual MCP configuration**. ByteRover will display the configuration steps to follow.
    </Warning>
  </Tab>

  <Tab title="Rules">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **OpenCode**
        3. Choose **Rules** connector
        4. Done — OpenCode will read `AGENTS.md` automatically
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install OpenCode --type rules
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Details">
    | Property                 | Value                         |
    | ------------------------ | ----------------------------- |
    | **Default connector**    | Skill                         |
    | **Supported connectors** | Skill, MCP, Rules             |
    | Skill directory          | `.opencode/skills/byterover/` |
    | Rule file                | `AGENTS.md`                   |
    | MCP config               | Manual setup                  |
    | Auto-detected            | Yes                           |
  </Tab>
</Tabs>

***

## Qwen Code

Qwen Code uses **MCP** as the default connector, with **rules** as a fallback.

<Tabs>
  <Tab title="MCP (Default)">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Qwen Code**
        3. Choose **MCP** connector
        4. Follow the **manual setup** instructions provided
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Qwen Code"
        ```
      </Tab>
    </Tabs>

    <Warning>
      Qwen Code requires **manual MCP configuration**. ByteRover will display the configuration steps to follow.
    </Warning>
  </Tab>

  <Tab title="Rules">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Qwen Code**
        3. Choose **Rules** connector
        4. Done — Qwen Code will read `QWEN.md` automatically
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install "Qwen Code" --type rules
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Details">
    | Property                 | Value        |
    | ------------------------ | ------------ |
    | **Default connector**    | MCP          |
    | **Supported connectors** | MCP, Rules   |
    | Rule file                | `QWEN.md`    |
    | MCP config               | Manual setup |
    | Auto-detected            | Yes          |
  </Tab>
</Tabs>

***

## Warp

Warp uses **Skill** as the default connector for comprehensive project-level guidance.

<Tabs>
  <Tab title="Skill (Default)">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Warp**
        3. Choose **Skill** connector (recommended)
        4. ByteRover creates `.warp/skills/byterover/` with:
           * `SKILL.md` — Quick reference with commands and best practices
           * `WORKFLOWS.md` — Detailed workflow patterns
           * `TROUBLESHOOTING.md` — Diagnostics and support info
        5. **Restart Warp** to discover the skill files
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

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

  <Tab title="MCP">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Warp**
        3. Choose **MCP** connector
        4. Follow the **manual setup** instructions provided
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install Warp --type mcp
        ```
      </Tab>
    </Tabs>

    <Warning>
      Warp requires **manual MCP configuration**. ByteRover will display the configuration steps to follow.
    </Warning>
  </Tab>

  <Tab title="Rules">
    <Tabs>
      <Tab title="TUI">
        1. Run `/connectors` in the ByteRover REPL
        2. Select **Warp**
        3. Choose **Rules** connector
        4. Done — Warp will read `WARP.md` automatically
      </Tab>

      <Tab title="CLI">
        Install via the CLI:

        ```bash theme={null}
        brv connectors install Warp --type rules
        ```
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Details">
    | Property                 | Value                     |
    | ------------------------ | ------------------------- |
    | **Default connector**    | Skill                     |
    | **Supported connectors** | Skill, MCP, Rules         |
    | Skill directory          | `.warp/skills/byterover/` |
    | Rule file                | `WARP.md`                 |
    | MCP config               | Manual setup              |
    | Auto-detected            | Yes                       |
  </Tab>
</Tabs>

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Curate Context" icon="sparkles" href="/common-workflows/curate-context">
    Learn how to add context to your knowledge base
  </Card>

  <Card title="Query Context" icon="search" href="/common-workflows/query-context">
    Retrieve context for your coding tasks
  </Card>
</CardGroup>
