### Getting Started with ByteRover CLI

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

Initializes your project by authenticating with ByteRover and setting up the project configuration. Authentication uses OAuth 2.0 with PKCE flow, storing credentials securely. The 'brv init' command creates a '.brv/' directory for configuration and context tree structure.

```bash
brv login
brv init
```

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

### Install ByteRover CLI

Source: https://docs.byterover.dev/beta/migration-br-brv

Instructions for uninstalling the old ByteRover CLI and installing the new version using npm. This ensures the 'brv' command is available for use.

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

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

### Troubleshoot ByteRover CLI Installation

Source: https://docs.byterover.dev/beta/migration-br-brv

Commands to verify the ByteRover CLI installation and check the installed version. This helps resolve 'command not found: brv' errors.

```bash
npm install -g byterover-cli
npm list -g  # byterover-cli should show version 0.2.0 or higher
```

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

### Example context.md File Content

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

Demonstrates the content of a `context.md` file, including markdown explanations, TypeScript code examples for custom error classes, and how to define relations to other topics.

```markdown
Always use custom error classes for better error handling in the Express API:

```typescript
// Custom error class pattern
class ValidationError extends Error {
  constructor(message: string) {
    super(message)
    this.name = 'ValidationError'
  }
}
```

Use try-catch blocks at route level and pass errors to middleware.

## Relations
@code_style/naming-conventions
@testing/integration-tests/api-tests
```

```markdown
## Relations
@code_style/error-handling
@testing/integration-tests
@structure/api-endpoints/validation
```

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

### Project Migration Steps for ByteRover CLI

Source: https://docs.byterover.dev/beta/migration-br-brv

Steps to migrate an existing ByteRover project to use the new 'brv' command. This includes removing old configurations, re-authenticating, and re-initializing the project.

```bash
cd to/your/project
br push
```

```bash
rm -rf .br
```

```bash
brv login
```

```bash
brv init
```

```bash
brv status
```

```bash
brv retrieve --query "your project context"
```

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

### Verify ByteRover CLI Installation

Source: https://docs.byterover.dev/beta/migration-br-brv

Command to check the installed version of the ByteRover CLI. It should display version 0.2.0 or higher after successful installation.

```bash
brv --version
```

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

### Update Scripts and CI/CD for ByteRover CLI

Source: https://docs.byterover.dev/beta/migration-br-brv

Example of updating ByteRover CLI commands in scripts and pipelines from 'br' to 'brv'. This is crucial for automated workflows.

```bash
# Before:
br login
br init
br push

# After:
brv login
brv init
brv push
```

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

### Example Context Tree Directory Structure

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

Illustrates the hierarchical organization of the context tree within the `.brv/context-tree/` directory, showing domains, topics, and the optional nesting of subtopics.

```tree
.brv/context-tree/
├── code_style/
│   ├── error-handling/
│   ├── naming-conventions/
│   └── api-design/
├── testing/
│   ├── integration-tests/
│   └── unit-tests/
└── structure/
    ├── api-endpoints/
    └── database-schema/
```

```tree
.brv/context-tree/
└── testing/
    └── integration-tests/
        ├── context.md              # Overview of integration testing
        └── api-tests/              # Subtopic
            └── context.md          # Specific to API testing
```

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

### Curate Context with Customization via Chat Prompt

Source: https://docs.byterover.dev/beta/common-workflows/add

This example demonstrates how to use a chat interface with ByteRover to customize context curation. Users can provide instructions, such as breaking context into smaller pieces or keeping it together, which are then translated into ByteRover CLI commands. This allows for flexible organization of knowledge.

```markdown
> curate the following context about health check implementation
> [Your content here]
> break it into small context pieces
```

```markdown
> curate the following context, break it into small focused pieces
> [Your content here]
```

```markdown
> curate the following context, keep it together as one topic
> [Your content here]
```

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

### Create ByteRover CLI Alias

Source: https://docs.byterover.dev/beta/migration-br-brv

Example of creating a shell alias to map the old 'br' command to the new 'brv' command. This can be added to shell configuration files like .bashrc or .zshrc.

```bash
# Add to your ~/.bashrc or ~/.zshrc
alias br='brv'
```

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

### Run Bytrover Curate Command

Source: https://docs.byterover.dev/beta/common-workflows/add

This command initiates the Bytrover context curation process. It is used in interactive mode to start the manual selection of domains and topics for adding new content to the context tree.

```bash
$ brv curate
```

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

### Example Context for Health Check Endpoint

Source: https://docs.byterover.dev/beta/common-workflows/add

This markdown content outlines the task, steps, and success criteria for adding a health check endpoint to an Express server. It serves as an example of the content that can be curated into the Bytrover context tree.

```markdown
# Health Check Endpoint

Task: Add a health check endpoint to the Express server

Steps:

1. Create basic Express server setup
   - File: src/server.ts
   - Set up Express app with TypeScript
   - Configure basic middleware

2. Create health check route
   - File: src/routes/health.ts
   - Implement GET /health endpoint
   - Return status, timestamp, uptime

3. Add types for response
   - File: src/types/health.ts
   - Define TypeScript interface

4. Create tests
   - File: tests/health.test.ts
   - Test endpoint returns 200
   - Validate response structure

5. Update package.json scripts
   - Add dev script
   - Add test script

Success Criteria:
- GET /health returns 200 status
- Response includes: status, timestamp, uptime
- TypeScript compiles without errors
- Tests pass

```

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

### Get ByteRover Status as JSON

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

The `brv status --format json` command outputs the current status of the ByteRover CLI and project in JSON format. This includes CLI version, authentication status, current directory, project initialization details, and context tree status.

```bash
brv status --format json
```

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

### Initialize ByteRover Project

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

The `brv init` command initializes a new ByteRover project. It creates a `.brv/config.json` file for team and space selection and sets up the project's context tree structure. It can be run interactively or with the `--force` flag for automation.

```bash
# Initialize project (interactive team/space selection)
brv init

# Complete first-time setup
brv login
brv init

# Force re-initialization without confirmation (for scripts/automation)
brv init --force
```

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

### Initializing a ByteRover Project

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

Initializes a new project for use with ByteRover CLI. This command prompts the user to select a team and space and creates a '.brv/' directory in the project with necessary configuration files and context tree structure.

```bash
brv init
```

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

### ByteRover CLI Global Options

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

Provides global options for the ByteRover CLI that can be used with any command. These options include '--help' to display command-specific help information and '--version' to show the current version of the CLI.

```bash
brv --help
brv init --help
brv --version
```

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

### Curate Project Context with ByteRover CLI

Source: https://docs.byterover.dev/beta/common-workflows/add

This command uses ByteRover's autonomous mode to curate and organize project context. It analyzes the provided task description, detects relevant domains, searches for existing knowledge, and creates or updates context topics hierarchically. Dependencies include the ByteRover CLI tool.

```bash
$ brv curate "Task: Add a health check endpoint to the Express server

Steps:

1. Create basic Express server setup
   - File: src/server.ts
   - Set up Express app with TypeScript
   - Configure basic middleware

2. Create health check route
   - File: src/routes/health.ts
   - Implement GET /health endpoint
   - Return status, timestamp, uptime

3. Add types for response
   - File: src/types/health.ts
   - Define TypeScript interface

4. Create tests
   - File: tests/health.test.ts
   - Test endpoint returns 200
   - Validate response structure

5. Update package.json scripts
   - Add dev script
   - Add test script

Success Criteria:
- GET /health returns 200 status
- Response includes: status, timestamp, uptime
- TypeScript compiles without errors
- Tests pass"
```

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

### Query ByteRover Context Tree

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

The `brv query` command enables agentic search within the project's context tree using natural language. It performs multi-step reasoning to find and synthesize comprehensive answers to questions about the codebase or project. Requires login and initialization.

```bash
# Query context tree about authentication
brv query "How is user authentication implemented?"

# Query about implementation details
brv query "What are the API rate limits and where are they enforced?"

# Query about project structure
brv query "What testing strategies are used?"
```

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

### Agent and Utility Commands

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

Commands for generating rules for coding agents and general help.

```APIDOC
## `brv gen-rules`

### Description
Generate rule instructions for coding agents based on the current project context and codebase.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv gen-rules
```

### Response
#### Success Response (200)
Generated rule instructions for coding agents.

#### Response Example
```json
{
  "rules": [
    "Follow SOLID principles.",
    "Use async/await for non-blocking operations.",
    "Document all public functions."
  ]
}
```
```

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

### Authenticating with ByteRover CLI

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

Logs the user into the ByteRover CLI using OAuth 2.0 with PKCE flow. This command opens a browser for authentication and securely stores tokens in the system's keychain. It's the first command to run when setting up ByteRover.

```bash
brv login
```

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

### Project and Status Commands

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

Commands for initializing and checking the status of a ByteRover project.

```APIDOC
## `brv init`

### Description
Initialize a project with ByteRover. This command prompts for team and space selection and creates a `.brv/` directory with configuration and context tree structure.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv init
```

### Response
#### Success Response (200)
Project initialized. `.brv/` directory created.

#### Response Example
(No direct output, indicates success via creation of `.brv/` directory and setup)
```

```APIDOC
## `brv status [DIRECTORY]`

### Description
Show CLI status and project information. Displays local context tree managed by ByteRover CLI for the specified or current directory.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
- `DIRECTORY` (string) - Optional - Project directory (defaults to current directory)

#### Query Parameters
- `-f, --format <option>` (string) - Optional - Output format: `table` or `json` (default: `table`)

#### Request Body
None

### Request Example
```bash
brv status
brv status /path/to/project
```

### Response
#### Success Response (200)
CLI status and project information.

#### Response Example
```json
{
  "project_path": "/path/to/your/project",
  "team": "YourTeam",
  "space": "YourSpace",
  "context_tree_size": 150,
  "last_synced": "2023-10-27T10:00:00Z"
}
```
```

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

### Context Management Commands

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

Commands for querying, pushing, pulling, curating, and clearing context from the ByteRover context tree.

```APIDOC
## `brv query <query>`

### Description
Intelligently search the context tree using agentic search with the provided query.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
- `query` (string) - Required - The search query to execute against the context tree.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv query "How is auth implemented?"
```

### Response
#### Success Response (200)
Search results from the context tree.

#### Response Example
```json
{
  "results": [
    {
      "document_id": "doc-xyz",
      "content": "Authentication uses JWT with a 24-hour expiry.",
      "source": "/path/to/knowledge/base/auth.md"
    }
  ],
  "summary": "Authentication is handled via JWT tokens valid for 24 hours."
}
```
```

```APIDOC
## `brv push`

### Description
Push the local context tree to ByteRover memory storage, synchronizing your local changes with the remote.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv push
```

### Response
#### Success Response (200)
Context tree successfully pushed to ByteRover memory storage.

#### Response Example
(No direct output, indicates success via completion of the command)
```

```APIDOC
## `brv pull`

### Description
Pull the context tree from ByteRover memory storage, synchronizing remote changes to your local context.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv pull
```

### Response
#### Success Response (200)
Context tree successfully pulled from ByteRover memory storage.

#### Response Example
(No direct output, indicates success via completion of the command)
```

```APIDOC
## `brv curate [content]`

### Description
Intelligently curate context to your context tree. You can provide content directly or have the CLI infer it from the environment.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
- `content` (string) - Optional - The context to curate. If not provided, the CLI may attempt to infer context.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv curate "Auth uses JWT with 24h expiry"
```

### Response
#### Success Response (200)
Context successfully curated and added to the context tree.

#### Response Example
(No direct output, indicates success via addition to the context tree)
```

```APIDOC
## `brv clear [DIRECTORY]`

### Description
Clear the local context tree. This command removes the local context data but does not affect remote storage.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
- `DIRECTORY` (string) - Optional - Project directory for which to clear the context tree (defaults to current directory).

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv clear
brv clear /path/to/project
```

### Response
#### Success Response (200)
Local context tree cleared.

#### Response Example
(No direct output, indicates success via completion of the command)
```

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

### Push Context Tree to ByteRover Memory Storage

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

The `brv push` command uploads your organized knowledge context tree to ByteRover's cloud storage. It supports specifying a ByteRover branch and optionally skipping the confirmation prompt. Ensure you are logged in and have initialized your project.

```bash
# Push to default branch (with confirmation)
brv push

# Push to a specific branch
brv push --branch develop
brv push -b feature-auth

# Skip confirmation prompt
brv push --yes
brv push -y
```

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

### List ByteRover Spaces

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

The `brv space list` command lists all available spaces for the current team. It supports options to list all spaces, specify a limit and offset for pagination, and output the results in JSON format. Requires prior project initialization.

```bash
# List first 50 spaces (default)
brv space list

# List all spaces
brv space list --all

# Manual pagination: get 10 spaces at a time
brv space list --limit 10
brv space list --limit 10 --offset 10

# Output as JSON
brv space list --json
```

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

### Curating Context with ByteRover CLI

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

Intelligently curates provided content and adds it to your project's context tree. This command helps in structuring and organizing information within your AI development workflow.

```bash
brv curate "Auth uses JWT with 24h expiry"
```

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

### Space Management Commands

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

Commands for listing and switching between ByteRover spaces.

```APIDOC
## `brv space list`

### Description
List all spaces for the current team.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
- `--all` (boolean) - Optional - Show all spaces across teams (requires appropriate permissions)

#### Request Body
None

### Request Example
```bash
brv space list
brv space list --all
```

### Response
#### Success Response (200)
A list of available ByteRover spaces.

#### Response Example
```json
[
  {
    "id": "space-123",
    "name": "Development",
    "team_id": "team-abc"
  },
  {
    "id": "space-456",
    "name": "Production",
    "team_id": "team-abc"
  }
]
```
```

```APIDOC
## `brv space switch`

### Description
Switch to a different team or space. This command interactively prompts the user to select a new team and space.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv space switch
```

### Response
#### Success Response (200)
Successfully switched to the selected team and space. Configuration updated.

#### Response Example
(No direct output, indicates success via completion of interactive prompts and updated configuration)
```

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

### Querying Context Tree with ByteRover CLI

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

Performs an intelligent search within the project's context tree using agentic search capabilities. The query string is passed as an argument.

```bash
brv query "How is auth implemented?"
```

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

### Listing ByteRover Spaces

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

Lists all available spaces for the current team. The '--all' flag can be used to list spaces across all accessible teams.

```bash
brv space list
brv space list --all
```

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

### Generating Rules for Coding Agents

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

Generates rule instructions intended for coding agents. This command assists in defining specific guidelines and behaviors for AI agents involved in coding tasks.

```bash
brv gen-rules
```

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

### Generate Rule Instructions for Coding Agents

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

The `brv gen-rules` command generates rule instruction files for coding agents to integrate with the ByteRover CLI in their workflow. You can specify the agent using the `--agent` flag or be prompted interactively.

```bash
# Generate rules (interactive agent selection)
brv gen-rules
```

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

### Authentication Commands

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

Commands for logging in and out of the ByteRover CLI.

```APIDOC
## `brv login`

### Description
Authenticate with ByteRover using OAuth 2.0 with PKCE flow. Opens your browser for secure authentication and stores tokens in your system's keychain.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
brv login
```

### Response
#### Success Response (200)
Authentication successful, tokens stored.

#### Response Example
(No direct output, indicates success via completion of browser flow and token storage)
```

```APIDOC
## `brv logout`

### Description
Log out of ByteRover CLI and clear authentication. Removes credentials from system keychain while preserving all local project files.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Flags
- `-y, --yes` (boolean) - Optional - Skip confirmation prompt

### Request Example
```bash
brv logout
brv logout --yes
```

### Response
#### Success Response (200)
Authentication cleared from system keychain.

#### Response Example
(No direct output, indicates success via completion of the command)
```

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

### Intelligently Organize and Add Context to Context Tree

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

The `brv curate` command intelligently organizes and adds context to your knowledge tree. It can operate in an interactive mode or an autonomous mode where you provide context as a string. This command requires project initialization.

```bash
# Interactive mode: Manually navigate context tree
brv curate

# Autonomous mode: System auto-categorizes your context
brv curate "Auth uses JWT with 24h expiry. Tokens stored in httpOnly cookies via authMiddleware.ts"

# Autonomous mode with detailed implementation
brv curate "API rate limit is 100 req/min per user. Implemented using Redis with sliding window in rateLimiter.ts"
```

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

### Switching ByteRover Spaces

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

Allows the user to switch to a different team or space within ByteRover. This command typically opens an interactive prompt to select the desired team and space.

```bash
brv space switch
```

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

### Pull Updates from Remote Space with brv CLI

Source: https://docs.byterover.dev/beta/context-tree/the-remote-space

This command synchronizes the organized context tree from the ByteRover remote space to your local environment. It updates the `.brv/context-tree/` directory with the latest changes made by your team.

```bash
brv pull
```

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

### Generate Rules for ByteRover Agent

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

Generates rules for a specified agent, used to help coding agents understand the ByteRover workflow. This command automatically prompts for overwrite confirmation if a rule file already exists and is typically called by the 'brv init' command. It requires an agent name as an argument.

```bash
brv gen-rules --agent claude-code
brv gen-rules -a cursor
```

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

### Push Context to Remote Space with brv CLI

Source: https://docs.byterover.dev/beta/context-tree/the-remote-space

This command pushes your local context tree to the ByteRover remote space for processing and synchronization. It's a core part of the workflow for updating the shared knowledge base.

```bash
brv push
```

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

### Pull Context Tree from ByteRover Memory Storage

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

The `brv pull` command downloads the organized context tree from ByteRover's cloud storage to your local environment. You can specify a ByteRover branch to pull from. This command is essential for syncing team changes.

```bash
# Pull from default branch
brv pull

# Pull from a specific branch
brv pull --branch develop
brv pull -b feature-auth
```

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

### Update Existing Context with ByteRover CLI

Source: https://docs.byterover.dev/beta/common-workflows/add

This command updates existing context within ByteRover's knowledge tree based on new instructions. It intelligently identifies related context and modifies it rather than creating duplicates. This is useful for refining existing information or adding new criteria to established topics. Requires the ByteRover CLI.

```bash
brv curate "Task: Add a health check endpoint to the Express server

Steps:

  1. Create basic Express server setup
     - File: src/server.ts
     - Set up Express app with TypeScript
     - Configure basic middleware

  2. Create health check route
     - File: src/routes/health.ts
     - Implement GET /health endpoint
     - Return status, timestamp, uptime

  3. Add types for response
     - File: src/types/health.ts
     - Define TypeScript interface

  4. Create tests
     - File: tests/health.test.ts
     - Test endpoint returns 200
     - Test endpoint returns JSON with health: ok

  5. Update package.json scripts
     - Add dev script
     - Add test script

Success Criteria:
  - GET /health returns 200 status
  - Response includes: status, timestamp, uptime
  - TypeScript compiles without errors
  - Tests pass"
```

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

### Checking ByteRover CLI Status

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

Displays the current status and project information for the ByteRover CLI, including the local context tree. It accepts an optional directory argument and supports 'table' or 'json' output formats.

```bash
brv status
brv status /path/to/project
brv status --format json
```

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

### Switch ByteRover Team or Space

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

The `brv space switch` command allows users to change the current team or space for their ByteRover project. This command updates the `.brv/config.json` file but does not re-initialize the context tree. It requires the project to be initialized first.

```bash
# Switch team or space (interactive)
brv space switch
```

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

### Logging Out of ByteRover CLI

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

Logs the user out of the ByteRover CLI, clearing authentication tokens from the system keychain. This command does not affect local project files. An optional '--yes' flag can be used to skip the confirmation prompt.

```bash
brv logout
brv logout --yes
brv logout -y
```

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

### Clear Local Context Tree Managed by ByteRover CLI

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

The `brv clear` command resets the local context tree managed by the ByteRover CLI to an empty structure. It can operate with a confirmation prompt or skip it using the `--yes` flag. You can also specify a project directory to clear.

```bash
# Clear context tree (with confirmation)
brv clear

# Clear without confirmation
brv clear --yes
brv clear -y

# Clear context tree in specific directory
brv clear /path/to/project
```

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

### Clearing Local Context Tree

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

Removes the local context tree managed by ByteRover CLI. This command can be used with an optional directory argument to clear the context for a specific project.

```bash
brv clear
brv clear /path/to/project
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.