### Install Content from a Specific Registry

Source: https://docs.byterover.dev/brv-hub/overview

When multiple registries are configured, you can specify which registry to install from using the `--registry` flag. This example installs a skill from a registry named 'myco'.

```bash
brv hub install byterover-review --registry myco --agent "Claude Code"
```

--------------------------------

### Run Hermes Model Setup Wizard

Source: https://docs.byterover.dev/cookbook/autonomous-local-model

Initiate the Hermes model setup process by running this command. This wizard guides you through selecting a custom provider for your local language model.

```bash
hermes setup model
```

--------------------------------

### Restart OpenCode CLI and Navigate to Project

Source: https://docs.byterover.dev/v4/agents/opencode-cli

After installing the skill, stop the current OpenCode CLI session and start a new one in your project directory. Agents load installed skills upon session start.

```bash
cd path/to/your/project
opencode
```

--------------------------------

### Quick Start Setup Script for OpenClaw

Source: https://docs.byterover.dev/autonomous-agents/openclaw

Run this script to automatically install and configure ByteRover as a context engine and memory curator for OpenClaw agents. It verifies prerequisites and updates workspace protocol files.

```bash
curl -fsSL https://byterover.dev/openclaw-setup.sh | sh
```

--------------------------------

### Install a context bundle

Source: https://docs.byterover.dev/reference/cli-reference

Installs a context bundle, which is placed in the .brv/context-tree/ directory. No agent is required for bundle installations.

```bash
# Install a context bundle (goes to .brv/context-tree/)
brv hub install typescript-kickstart
```

--------------------------------

### Install a Context Bundle with `brv hub install`

Source: https://docs.byterover.dev/brv-hub/overview

Install a context bundle by its ID. Context bundles do not require an agent to be specified. This command installs the bundle directly to your project's context tree.

```bash
brv hub install typescript-kickstart
```

--------------------------------

### Basic CLI Usage for Hub Operations

Source: https://docs.byterover.dev/brv-hub/overview

These examples demonstrate the fundamental commands for interacting with the ByteRover Hub via the CLI. They cover listing available content and installing both skills and bundles.

```bash
brv hub list
```

```bash
brv hub install byterover-review --agent "Claude Code"
```

```bash
brv hub install typescript-kickstart
```

--------------------------------

### Demonstrate `--force` flag for Worktree Addition

Source: https://docs.byterover.dev/knowledge-sharing/worktrees

This example illustrates the use of the `--force` flag when adding a worktree that already has its own `.brv/` setup. The existing `.brv/` is backed up to `.brv-backup/`.

```bash
brv worktree add packages/api --force
```

--------------------------------

### Navigate to Project and Start Claude Code

Source: https://docs.byterover.dev/v4/agents/claude-code

Change to your project directory and start a new Claude Code session to load the installed skills.

```bash
cd path/to/your/project
claude
```

--------------------------------

### Install Clawhub Skill Manually

Source: https://docs.byterover.dev/autonomous-agents/openclaw-reference

Manually install the Clawhub skill using npx if the setup script fails.

```bash
npx clawhub@latest install byterover --force
```

--------------------------------

### Install GitHub Copilot Rules Connector via CLI

Source: https://docs.byterover.dev/connectors/vscode-extensions

Use this command to install the GitHub Copilot connector with the Rules connector type. This setup allows Copilot to automatically read instructions from `.github/copilot-instructions.md`.

```bash
brv connectors install "Github Copilot" --type rules
```

--------------------------------

### Install Content with Specified Scope

Source: https://docs.byterover.dev/brv-hub/overview

Control the installation scope using the `--scope` flag. 'project' installs to the current directory's context, while 'global' installs to your home directory. The default scope is 'project'.

```bash
brv hub install <id> [OPTIONS]
```

--------------------------------

### Install IDE Connectors via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Install default connectors for supported IDEs using the `brv connectors install` command. Specify the IDE name to install its primary connector.

```bash
brv connectors install Cursor
brv connectors install Windsurf
brv connectors install Antigravity
```

--------------------------------

### Install a Skill with `brv hub install`

Source: https://docs.byterover.dev/brv-hub/overview

Install a specific agent skill by its ID. The `--agent` flag is required to specify the target agent for the skill. For example, install a skill for Claude Code.

```bash
brv hub install byterover-review --agent "Claude Code"
```

```bash
brv hub install byterover-plan --agent Cursor
```

--------------------------------

### Remove example entries

Source: https://docs.byterover.dev/brv-hub/registries

Delete the example `skills` and `bundles` directories from the cloned repository.

```bash
rm -rf skills/*
rm -rf bundles/*
```

--------------------------------

### Restart Codex CLI and Navigate to Project

Source: https://docs.byterover.dev/v4/agents/codex-cli

After installing the skill, stop the current Codex CLI session and start a new one in your project directory. Agents load installed skills upon session start.

```bash
cd path/to/your/project
codex
```

--------------------------------

### Install Skill from Private Registry

Source: https://docs.byterover.dev/brv-hub/registries

Install a specific skill from your private registry using the BRV CLI.

```bash
brv hub install my-internal-skill --registry my-team --agent "Claude Code"
```

--------------------------------

### Example ByteRover Project Structure After Curation

Source: https://docs.byterover.dev/reference/cli-reference

An example of the ByteRover project structure after content curation, showing organized knowledge domains.

```bash
.brv/context-tree/
├── authentication/
│   ├── context.md
│   └── jwt/
│       ├── context.md
│       ├── token_refresh_strategy.md
│       └── token_validation.md
├── api/
│   └── endpoints/
│       └── rate_limiting.md
└── testing/
    └── integration_tests/
        └── api_testing_patterns.md
```

--------------------------------

### Install Community Agent Skills via CLI

Source: https://docs.byterover.dev/connectors/vscode-extensions

After installing the main connector, you can install additional community agent skills from the BRV Hub. Specify the agent to install the skill for.

```bash
brv hub install byterover-review --agent "Github Copilot"
```

--------------------------------

### Install OpenCode Connector via CLI (Rules)

Source: https://docs.byterover.dev/connectors/cli-tools

Use this command to install the OpenCode connector with the Rules connector type.

```bash
brv connectors install OpenCode --type rules
```

--------------------------------

### Specify Registry for Installation

Source: https://docs.byterover.dev/brv-hub/registries

Use the `--registry` flag to specify which registry to install from when an entry ID exists in multiple registries.

```bash
brv hub install my-skill --registry myco --agent "Claude Code"
```

--------------------------------

### Install Kiro Connector via CLI

Source: https://docs.byterover.dev/connectors/vscode-extensions

Use this command to install the Kiro connector using the ByteRover CLI. This is the default installation method for the Skill connector.

```bash
brv connectors install Kiro
```

--------------------------------

### Install Qoder Skill Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Use this command to install the default Skill connector for Qoder. Ensure ByteRover CLI is set up.

```bash
brv connectors install Qoder
```

--------------------------------

### Install Qoder Rules Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Use this command to install the Rules connector for Qoder. Specify the type as 'rules'.

```bash
brv connectors install Qoder --type rules
```

--------------------------------

### Install Cursor Skill Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Install the default Skill connector for the Cursor IDE using the `brv connectors install Cursor` command. This is the recommended method for comprehensive project-level guidance.

```bash
brv connectors install Cursor
```

--------------------------------

### Install Trae.ai with Rules Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Install Trae.ai using the Rules connector. Trae.ai will then automatically read the `project_rules.md` file for guidance.

```bash
brv connectors install Trae.ai --type rules
```

--------------------------------

### Install Junie Connector via CLI

Source: https://docs.byterover.dev/connectors/vscode-extensions

Use this command to install the Junie connector using the ByteRover CLI. This is the default installation method for the Skill connector.

```bash
brv connectors install Junie
```

--------------------------------

### Install OpenCode Connector via CLI (Default)

Source: https://docs.byterover.dev/connectors/cli-tools

Use this command to install the OpenCode connector with the default Skill connector type.

```bash
brv connectors install OpenCode
```

--------------------------------

### Hermes Interactive Memory Setup

Source: https://docs.byterover.dev/autonomous-agents/hermes

Recommended interactive setup for configuring ByteRover as the memory provider for Hermes agents. Select 'byterover' when prompted.

```bash
hermes memory setup
```

--------------------------------

### Install Gemini CLI with Skill Connector

Source: https://docs.byterover.dev/connectors/cli-tools

Use this command to install the Gemini CLI with the default Skill connector via the command line.

```bash
brv connectors install "Gemini CLI"
```

--------------------------------

### Install Windsurf Rules Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Use this command to install the Rules connector for Windsurf. Specify the type as 'rules'.

```bash
brv connectors install Windsurf --type rules
```

--------------------------------

### Install OpenCode Connector via CLI (MCP)

Source: https://docs.byterover.dev/connectors/cli-tools

Use this command to install the OpenCode connector with the MCP connector type.

```bash
brv connectors install OpenCode --type mcp
```

--------------------------------

### Local to Cloud Setup with ByteRover (CLI)

Source: https://docs.byterover.dev/git-semantic/getting-started

Initialize a local project, commit changes, and then connect to a remote ByteRover space. This process includes logging in and pushing your local commits to the cloud.

```bash
brv vc init
brv vc config user.name "Alice Chen"
brv vc config user.email "alice@example.com"
brv vc add .
brv vc commit -m "initial context tree"
brv login
brv vc remote add origin https://byterover.dev/acme/project.git
brv vc push -u origin main
```

--------------------------------

### Install Agent Connector - Bash

Source: https://docs.byterover.dev/review/agent-workflow

Install a ByteRover connector for your agent to enable agent-driven reviews. This teaches the agent the `brv review` commands.

```bash
brv connectors install "<agent name>"
```

--------------------------------

### Install Gemini CLI with Rules Connector

Source: https://docs.byterover.dev/connectors/cli-tools

Use this command to install the Gemini CLI with the Rules connector type via the command line.

```bash
brv connectors install "Gemini CLI" --type rules
```

--------------------------------

### Install Windsurf Skill Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Use this command to install the default Skill connector for Windsurf. Ensure ByteRover CLI is set up.

```bash
brv connectors install Windsurf
```

--------------------------------

### Install Amp Connector via CLI

Source: https://docs.byterover.dev/connectors/vscode-extensions

Use this command to install the Amp connector using the ByteRover CLI. This defaults to the Skill connector.

```bash
brv connectors install Amp
```

--------------------------------

### Topic Context Markdown Example

Source: https://docs.byterover.dev/context-tree/local-space-structure

Example of an auto-generated `context.md` file for a topic, summarizing its focus, key concepts, and related topics.

```markdown
# Topic: jwt-implementation

## Overview
Patterns and conventions for JSON Web Token generation, validation, and rotation.

## Key Concepts
- Access tokens expire after 24 hours
- Refresh token rotation prevents replay attacks
- Token signing uses RS256 algorithm

## Related Topics
- authentication/oauth-flow
- database/user-models
```

--------------------------------

### Switch to Qwen Model via CLI

Source: https://docs.byterover.dev/cookbook/autonomous-local-model

After connecting to the local provider, use this command to select the 'qwen3.5-9b' model for use with ByteRover.

```bash
brv model switch qwen3.5-9b
```

--------------------------------

### Install Zed with MCP Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Use this command to install the Zed connector with MCP as the default. ByteRover will automatically configure the necessary settings.

```bash
brv connectors install Zed
```

--------------------------------

### Example /query Output

Source: https://docs.byterover.dev/common-workflows/query-context

Observe the typical output format when using the `/query` command, showing the query process and the synthesized results with citations.

```bash
/query What is the context tree structure?
Querying context tree...
🔧 search_knowledge → Querying knowledge base...
✅ search_knowledge → Complete (2 topics retrieved)

Query Results:
The context tree is a hierarchical file-based structure...
```

--------------------------------

### Install Default Connector via CLI

Source: https://docs.byterover.dev/connectors/desktop-apps

Install the default connector for an application using the ByteRover CLI. This command is used for initial setup.

```bash
brv connectors install "Claude Desktop"
```

--------------------------------

### Local to Cloud Setup with ByteRover (TUI)

Source: https://docs.byterover.dev/git-semantic/getting-started

Configure your local project for version control and synchronize it with a remote ByteRover space using the TUI. This includes logging in and pushing to the remote origin.

```bash
/vc init
/vc config user.name "Alice Chen"
/vc config user.email "alice@example.com"
/vc add .
/vc commit -m "initial context tree"
/login
/vc remote add origin https://byterover.dev/acme/project.git
/vc push -u origin main
```

--------------------------------

### List All Settings

Source: https://docs.byterover.dev/reference/brv-settings

Use this command to list all available settings, grouped by category. Changes to most settings require `brv restart` to take effect.

```bash
brv settings                       # List all settings, grouped by category
brv settings list                  # Alias for the bare `brv settings`
```

--------------------------------

### Verify ByteRover Proxy Setup

Source: https://docs.byterover.dev/faqs/troubleshooting

Run this command after setting proxy environment variables to confirm your setup is working correctly. Successful authentication indicates the proxy configuration is functional.

```bash
brv login
```

--------------------------------

### Install ByteRover CLI via npm

Source: https://docs.byterover.dev/faqs/installation-updates

Install the ByteRover CLI globally using npm. This method requires Node.js version 20 or higher.

```bash
npm install -g byterover-cli
```

--------------------------------

### Domain-Scoped Query Example

Source: https://docs.byterover.dev/context-tree/query-engine

Shows how a query starting with a known domain name is automatically scoped to that domain, even without a preceding slash.

```plaintext
authentication refresh token rotation
```

--------------------------------

### Example Worktree List Output (Project Root)

Source: https://docs.byterover.dev/knowledge-sharing/worktrees

Example output from `brv worktree list` when executed from the project root, showing the project directory and its registered worktrees.

```text
Project: /monorepo

Registered worktrees:
   packages-api → /monorepo/packages/api
   packages-web → /monorepo/packages/web
```

--------------------------------

### Initialize Version Control and Configure User

Source: https://docs.byterover.dev/common-workflows/team-context-sync

Initialize Git-Semantic version control for your local space and configure your user name and email. This is the first step when setting up a new remote space.

```bash
brv vc init
brv vc config user.name "Your Name"
brv vc config user.email "you@example.com"
```

--------------------------------

### Search Integration Example

Source: https://docs.byterover.dev/knowledge-sharing/sources

Demonstrates how search results are displayed when sources are configured, including origin attribution. Results are prefixed with `[local]` for local content and `[alias]` for content from a configured source.

```bash
brv query "JWT validation"

# Results might include:
# [local]:authentication/jwt-implementation/context.md     (your project)
# [auth]:security/token-validation/context.md              (from auth source)
```

--------------------------------

### Pipe JSON Results to jq for Filtering

Source: https://docs.byterover.dev/memory-swarm/query

When the query output is in JSON format, you can pipe it to tools like `jq` to extract specific fields. This example shows how to get the provider and score for each result.

```bash
brv swarm query "API design" --format json | jq '.results[] | {provider, score}'
```

--------------------------------

### Install Antigravity with Skill Connector CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Use this command to install the Antigravity connector with the Skill connector type via the CLI. This is the default and recommended connector.

```bash
brv connectors install Antigravity
```

--------------------------------

### Verify ByteRover Connection

Source: https://docs.byterover.dev/v4/agents/claude-code

Ask Claude Code to query ByteRover for the current project to verify the setup before starting work. Claude Code should query memory before non-trivial tasks and record knowledge upon completion.

```text
query ByteRover for this project
```

--------------------------------

### Domain Structure Example

Source: https://docs.byterover.dev/context-tree/local-space-structure

Illustrates the directory structure for domains and their auto-generated `context.md` files within the `.brv/context-tree/` directory.

```tree
.brv/context-tree/
├── authentication/
│   └── context.md        # auto-generated domain overview
├── api-design/
│   └── context.md
└── database/
    └── context.md
```

--------------------------------

### Verify ByteRover CLI Installation

Source: https://docs.byterover.dev/faqs/installation-updates

After installation, run this command to verify that the ByteRover CLI is installed correctly and to check its version.

```bash
brv --version
```

--------------------------------

### Install Auggie CLI MCP Connector

Source: https://docs.byterover.dev/connectors/cli-tools

Installs the Auggie CLI connector with the MCP type. Manual configuration is required after installation.

```bash
brv connectors install "Auggie CLI" --type mcp
```

--------------------------------

### Initialize Local Project Version Control (CLI)

Source: https://docs.byterover.dev/git-semantic/getting-started

Set up a new project for local version control using the ByteRover CLI. This initializes the project and configures version control without connecting to a remote space.

```bash
brv vc init
brv vc config user.name "Alice Chen"
brv vc config user.email "alice@example.com"
brv vc add .
brv vc commit -m "initial context tree"
brv vc checkout -b experiment
```

--------------------------------

### Install Codex Connector via CLI

Source: https://docs.byterover.dev/connectors/cli-tools

Use this command to install the default Skill connector for Codex. Ensure you have the ByteRover CLI installed.

```bash
brv connectors install Codex
```

--------------------------------

### Agentic Search Query Example

Source: https://docs.byterover.dev/common-workflows/query-context

Example output from the `brv query` command, showing the search process and the retrieved context tree structure. This demonstrates how ByteRover combines search strategies for relevant results.

```bash
$ brv query "What is the context tree structure?"
Querying context tree...
🔧 search_knowledge → Querying knowledge base...
✅ search_knowledge → Complete (2 topics retrieved)

Query Results:
The context tree is a hierarchical file-based structure used to store and organize knowledge. Here's an overview of its structure:

**Location:** The context tree is stored in the `.brv/context-tree/` directory.

**Domains:**
The top level of the tree consists of a predefined set of domain folders. These domains include categories like `architecture`, `components`, and `apis`.

**Topics:**
Within each domain folder, there are topic subfolders. Each topic folder represents a specific area of knowledge within that domain.

**Content:**
The actual knowledge is stored in markdown files within each topic folder. These files have descriptive names based on their content and are timestamped.
```

--------------------------------

### Example Source List Output

Source: https://docs.byterover.dev/knowledge-sharing/sources

Illustrates the output format for the `brv source list` command, showing configured sources with their aliases, paths, and validation status. Includes an example of a broken source.

```text
Knowledge Sources:
   shared-lib → /path/to/shared-lib (valid)
   auth → /path/to/auth-service (valid)
```

```text
Knowledge Sources:
   shared-lib → /path/to/shared-lib (valid)
   auth → /deleted/path [BROKEN - run brv source remove auth]
```

--------------------------------

### Install a skill to a coding agent

Source: https://docs.byterover.dev/reference/cli-reference

Installs a skill to a specified agent. The skill ID is required, and the target agent must be provided for skill installations.

```bash
# Install a skill to a coding agent
brv hub install byterover-review --agent "Claude Code"
brv hub install byterover-plan --agent Cursor
```

--------------------------------

### Install Default Connectors for CLI Tools

Source: https://docs.byterover.dev/connectors/cli-tools

Install the default connector for various CLI tools. This command installs the 'Skill' connector by default for each tool.

```bash
brv connectors install "Claude Code"
brv connectors install "Gemini CLI"
brv connectors install "Auggie CLI"
brv connectors install "OpenClaude"
```

--------------------------------

### Install a skill globally

Source: https://docs.byterover.dev/reference/cli-reference

Installs a skill to the global scope for the agent, requiring the agent to be specified. Use the --scope global flag for global installations.

```bash
# Install globally
brv hub install byterover-debug --agent "Claude Code" --scope global
```

--------------------------------

### Complete Memory Swarm Configuration Example

Source: https://docs.byterover.dev/memory-swarm/setup

This snippet shows a comprehensive example of the Memory Swarm configuration file, including all available sections and common settings for providers, routing, performance, and enrichment.

```yaml
# Provider configuration
providers:
  byterover:
    enabled: true

  obsidian:
    enabled: true
    vault_path: /Users/you/Documents/MyObsidian
    ignore_patterns:
      - ".trash"
      - ".obsidian"
    index_on_startup: true    # Build search index on first query
    read_only: true           # Prevent writes to vault
    watch_for_changes: true   # Auto-rebuild index on file changes

  local_markdown:
    enabled: true
    watch_for_changes: true
    folders:
      - name: project-docs
        path: /Users/you/Documents/local-markdown
        read_only: false        # Allow writes
        follow_wikilinks: true  # Index wikilink targets

  gbrain:
    enabled: true
    repo_path: /Users/you/workspaces/gbrain
    search_mode: hybrid   # hybrid | keyword | vector

  memory_wiki:
    enabled: true
    vault_path: /Users/you/.openclaw/wiki/main
    boost_fresh: true           # Score boost for recently updated pages
    write_page_type: concept    # concept | entity

# Query routing
routing:
  classification_method: auto   # auto | manual
  default_strategy: adaptive
  default_max_results: 10
  rrf_k: 60                    # RRF constant (higher = more uniform ranking)
  min_rrf_score: 0.005         # Floor — drop results below this
  rrf_gap_ratio: 0.5           # Drop results scoring below 50% of top result

# Performance tuning
performance:
  max_query_latency_ms: 2000
  max_concurrent_providers: 4
  file_watcher_debounce_ms: 1000
  index_cache_ttl_seconds: 300
  result_cache_ttl_ms: 10000   # In-memory LRU cache for repeated queries

# Enrichment topology
enrichment:
  edges:
    - from: byterover
      to: obsidian
    - from: byterover
      to: local-markdown
    - from: byterover
      to: memory-wiki

# Budget controls (cloud providers only)
budget:
  global_monthly_cap_cents: 5000     # $50 default
  warning_threshold_pct: 80
  weight_reduction_threshold_pct: 90

```

--------------------------------

### Install ByteRover CLI

Source: https://docs.byterover.dev/autonomous-agents/hermes-reference

Install the ByteRover CLI using either a curl script or npm. Ensure to restart your shell or source the PATH update after installation.

```bash
curl -fsSL https://byterover.dev/install.sh | sh
```

```bash
npm install -g byterover-cli
```

--------------------------------

### Install Default Connectors via CLI

Source: https://docs.byterover.dev/connectors/vscode-extensions

Install the default connector for VS Code extensions using the ByteRover CLI. This command installs the connector for the specified extension.

```bash
brv connectors install "Github Copilot"
brv connectors install "Kilo Code"
brv connectors install Cline
```

--------------------------------

### Manually Update ByteRover CLI (curl install)

Source: https://docs.byterover.dev/faqs/installation-updates

If you installed ByteRover CLI via the curl script, use this command to manually update it. This command is not applicable for npm installations.

```bash
brv update
```

--------------------------------

### Curate and Query Auth Patterns

Source: https://docs.byterover.dev/knowledge-sharing/sources

Demonstrates how to curate knowledge from one project and reference it from another. Ensure you are in the correct project directory before running commands.

```bash
cd /auth-service
brv curate "JWT tokens use RS256, expire in 24h, refresh tokens in 7d"

cd /product-api
brv source add /auth-service --alias auth

brv query "token expiration policy"
# Returns: [auth]:security/jwt-tokens/context.md
```

--------------------------------

### Launch Local Web UI

Source: https://docs.byterover.dev/local-web-ui/getting-started

Run this command from any project directory to launch the ByteRover local web UI. It automatically picks a free port and opens your browser.

```bash
brv webui
```

--------------------------------

### Install Community Agent Skill via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Install additional community agent skills, such as `byterover-review`, for a specific agent like Cursor, using the `brv hub install` command.

```bash
brv hub install byterover-review --agent Cursor
```

--------------------------------

### Open a New ByteRover Project

Source: https://docs.byterover.dev/local-web-ui/projects

Navigate to your project folder in the terminal and run this command to open it in the ByteRover web UI. Each folder ByteRover detects becomes a distinct project.

```bash
cd path/to/your/project
brv webui
```

--------------------------------

### Install Specific Connector Type via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Install a specific connector type (e.g., `rules`, `mcp`) for an IDE by using the `--type` or `-t` flag with the `brv connectors install` command.

```bash
brv connectors install Cursor --type rules
brv connectors install Windsurf --type mcp
```

--------------------------------

### Install Cursor Rules Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Install the Rules connector for the Cursor IDE using the `brv connectors install Cursor --type rules` command. This enables Cursor to read `.cursor/rules/agent-context.mdc`.

```bash
brv connectors install Cursor --type rules
```

--------------------------------

### Install Cursor MCP Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Install the MCP connector for the Cursor IDE using the `brv connectors install Cursor --type mcp` command. This configures `.cursor/mcp.json` for the MCP server.

```bash
brv connectors install Cursor --type mcp
```

--------------------------------

### Install Zed with Rules Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Use this command to install the Zed connector specifically for the Rules connector. Zed will then automatically read the `agent-context.rules` file.

```bash
brv connectors install Zed --type rules
```

--------------------------------

### Example Worktree List Output (Linked Worktree)

Source: https://docs.byterover.dev/knowledge-sharing/worktrees

Example output from `brv worktree list` when executed from a linked worktree, showing the current worktree and its linked project.

```text
Worktree: /monorepo/packages/api
Linked to: /monorepo

Registered worktrees:
   packages-api → /monorepo/packages/api
   packages-web → /monorepo/packages/web
```

--------------------------------

### List Installed Connectors

Source: https://docs.byterover.dev/reference/cli-reference

Lists all installed coding agent connectors. Supports JSON output format.

```bash
brv connectors
```

```bash
brv connectors list
```

```bash
brv connectors --format json
```

--------------------------------

### Create manifest.json for an entry

Source: https://docs.byterover.dev/brv-hub/registries

Example `manifest.json` file for a new agent skill or bundle entry, including essential metadata.

```json
{
  "id": "my-internal-skill",
  "name": "My Internal Skill",
  "version": "1.0.0",
  "description": "An internal skill for our team's code review workflow",
  "type": "agent-skill",
  "author": { "name": "Your Team" },
  "tags": ["internal", "review"],
  "category": "code-quality"
}
```

--------------------------------

### Single-Response Command JSON Example

Source: https://docs.byterover.dev/headless-mode/overview

Example of a JSON output for commands that return a single response, such as 'status'.

```json
{"command":"status","data":{"authStatus":"logged_in","userEmail":"dev@example.com","currentDirectory":"/project","teamName":"my-team","spaceName":"my-space","contextTreeStatus":"no_changes","cliVersion":"2.0.0"},"success":true,"timestamp":"2026-01-15T10:30:00.000Z"}
```

--------------------------------

### Run Memory Swarm Onboard Wizard

Source: https://docs.byterover.dev/memory-swarm/setup

Initiates the interactive wizard for setting up memory providers. Follow the prompts to configure paths, API keys, and other settings.

```bash
brv swarm onboard
```

--------------------------------

### Store with Explicit Provider (GBrain)

Source: https://docs.byterover.dev/memory-swarm/curate

This example demonstrates storing content to the GBrain provider explicitly using the short flag '-p'.

```bash
brv swarm curate "# Database Migration Guide\nAlways use reversible migrations" -p gbrain
```

--------------------------------

### Install OpenClaude Skill Connector via CLI

Source: https://docs.byterover.dev/connectors/cli-tools

Use this command to install the default Skill connector for OpenClaude.

```bash
brv connectors install "OpenClaude"
```

--------------------------------

### Run OpenClaw Onboard Wizard

Source: https://docs.byterover.dev/cookbook/autonomous-local-model

Execute this command to start the OpenClaw agent configuration wizard. Follow the prompts to select a custom provider and enter local model details.

```bash
openclaw onboard
```

--------------------------------

### Uninstall ByteRover CLI (npm install)

Source: https://docs.byterover.dev/faqs/installation-updates

If you installed ByteRover CLI using npm, use this command to uninstall it globally.

```bash
npm uninstall -g byterover-cli
```

--------------------------------

### Error Response JSON Example

Source: https://docs.byterover.dev/headless-mode/overview

Example of a JSON output for an error response, indicating failure with details in the 'data' field.

```json
{"command":"query","data":{"error":"No provider connected","status":"error"},"success":false,"timestamp":"2026-01-15T10:30:00.000Z"}
```

--------------------------------

### Install Trae.ai with Skill Connector via CLI

Source: https://docs.byterover.dev/connectors/ai-ides

Install Trae.ai using the Skill connector, which is the recommended default. This command automatically sets up the necessary skill files.

```bash
brv connectors install Trae.ai
```

--------------------------------

### Domain Context Markdown Example

Source: https://docs.byterover.dev/context-tree/local-space-structure

Example of an auto-generated `context.md` file for a domain, outlining its purpose, scope, ownership, and usage.

```markdown
# Domain: authentication

## Purpose
Covers all authentication and authorization patterns used in this project.

## Scope
Included in this domain:
- JWT token generation and validation
- OAuth 2.0 flows
- Session management and refresh tokens

Excluded from this domain:
- API rate limiting (see api-design)
- Database user models (see database)

## Ownership
Backend team

## Usage
Reference when implementing login flows, token handling, or access control.
```

--------------------------------

### Launch ByteRover TUI

Source: https://docs.byterover.dev/quickstart

Navigate to your project directory and run the `brv` command to launch the ByteRover TUI. This is the first step to interact with ByteRover through its terminal interface.

```bash
cd path/to/your/project
brv
```

--------------------------------

### Start Interactive TUI

Source: https://docs.byterover.dev/reference/cli-reference

Launch the terminal UI by running `brv` with no arguments. This starts a persistent session with a React/Ink-based interface.

```bash
brv
```

--------------------------------

### Install Qwen Code Connector via CLI

Source: https://docs.byterover.dev/connectors/cli-tools

Use this command to install the Qwen Code connector using the default MCP type via the ByteRover CLI.

```bash
brv connectors install "Qwen Code"
```

--------------------------------

### Install Auggie CLI Skill Connector

Source: https://docs.byterover.dev/connectors/cli-tools

Installs the Auggie CLI connector using the Skill connector type, which is the recommended default.

```bash
brv connectors install "Auggie CLI"
```

--------------------------------

### Install GitHub Copilot Skill Connector via CLI

Source: https://docs.byterover.dev/connectors/vscode-extensions

Use this command to install the GitHub Copilot connector with the Skill connector type. This is the recommended default for comprehensive project-level guidance.

```bash
brv connectors install "Github Copilot"
```

--------------------------------

### Install Coding Agent

Source: https://docs.byterover.dev/index

Installs a specified coding agent, such as 'Claude Code'. This command extends the capabilities of your AI coding agents.

```bash
brv connectors install "Claude Code"
```

--------------------------------

### Query with Parent Project and Added Sources

Source: https://docs.byterover.dev/knowledge-sharing/worktrees

This example shows a query executed from a worktree that searches both the monorepo's context tree and an additionally added source.

```bash
cd /monorepo/packages/api
brv query "button component"
```