brv) is a command-line tool for managing your AI development workflow with ByteRover. Use it to authenticate, retrieve memories from your knowledge base, manage projects and spaces, and maintain your context tree.
For help with any command, run brv --help or brv <command> --help.
Getting Started
ByteRover CLI offers two ways to interact: Interactive REPL mode (recommended) and traditional CLI commands.Interactive REPL Mode (Recommended)
Start the interactive terminal UI by runningbrv with no arguments:
Esc at any time to skip onboarding.
Standalone CLI Commands
A few commands are also available as standalone CLI commands for scripting and quick access:CLI Commands
| Command | Description | Example |
|---|---|---|
brv | Start interactive REPL mode (recommended) | brv |
brv status [DIRECTORY] | Show CLI status and project information | brv status |
brv query <QUERY> | Query information from the context tree | brv query "How is auth implemented?" |
brv curate [CONTEXT] [--files] | Add content to context tree | brv curate "JWT tokens expire in 24h" --files src/auth.ts |
Note: Commands likelogin,logout,init,push,pull,space,gen-rules, andclearare only available as slash commands in REPL mode. Runbrvto start REPL mode.
Command Details
brv
Start the interactive REPL mode with a React/Ink-based terminal UI. This is the recommended way to use ByteRover CLI for an enhanced user experience.
Arguments
None
Flags
None
Examples
- Persistent session: Stay in the CLI and run multiple commands without restarting
- Slash commands: Use
/commandsyntax for all operations (e.g.,/login,/push,/query) - Interactive onboarding: First-time users get a guided setup flow (press
Escto skip) - Real-time feedback: See streaming responses and progress indicators
- Tab completion: Auto-complete slash commands as you type
| Command | Description |
|---|---|
/login | Authenticate with ByteRover |
/logout | Log out and clear authentication |
/init | Initialize project with team/space selection |
/status | Show auth, config, and context tree state |
/curate [context] [--files <paths>] | Add content to context tree |
/query <query> | Query information from context tree |
/push [--branch <name>] | Push context tree to cloud |
/pull [--branch <name>] | Pull context tree from cloud |
/space list | List all spaces for current team |
/space switch | Switch to different team or space |
/gen-rules | Generate agent-specific rule files |
/clear | Reset context tree to default domains |
- REPL mode is the primary way to use ByteRover CLI
- Most commands (login, init, push, pull, etc.) are only available in REPL mode
- Use
Ctrl+Cto exit REPL mode
brv status
Show CLI status and project information. Displays local context tree managed by ByteRover CLI.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
DIRECTORY | string | No | Project directory (defaults to current directory) |
| Flag | Description | Default |
|---|---|---|
-f, --format <option> | Output format: table or json | table |
- CLI version
- Authentication status (logged in user or “Not logged in”)
- Current directory
- Project initialization status (team and space info if initialized)
- Context tree changes (git-style diff showing modified/added/deleted files)
brv query
Query and retrieve information from the context tree using natural language.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
QUERY | string | Yes | Natural language question about your project |
- Context tree must exist (run
/initin REPL mode first) - Uses AI to search and analyze your context tree
- Best results with specific, detailed questions
- Avoid vague queries like “auth” or “show me code”
brv curate
Add content to the context tree using interactive or autonomous mode.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
CONTEXT | string | No | Content to add (triggers autonomous mode if provided) |
| Flag | Description | Default |
|---|---|---|
--files <paths> | Include file references in autonomous curation (comma-separated or multiple flags) | None |
- Context tree must exist (run
/initin REPL mode first) - Interactive mode: Navigate context tree, select domain/topic, creates context.md file
- Autonomous mode: ByteRover agent automatically determines best location and adds content
- File references: Use
--filesor@to provide source files as additional context for the AI agent. Files must be text files within the project directory
Global Options
ByteRover CLI provides these global options:| Flag | Description | Example |
|---|---|---|
--help | Show help for command | brv --help, brv status --help |
--version | Show CLI version | brv --version |
File Structure
ByteRover CLI creates the following directory structure in your project:- config.json: Stores your team ID, space ID, and project metadata
- context-tree/: Hierarchical structure organizing project knowledge by domains and topics
- .snapshot.json: Version control snapshot tracking context tree changes over time
- Each domain can contain multiple topics, and each topic has a
context.mdfile with actual content