Thanks to visit codestin.com
Credit goes to docs.byterover.dev

Skip to main content

​
Prerequisites

  • ByteRover account (sign up)
  • An active team and space in ByteRover’s web app
  • Node.js 20+
  • Your coding agent IDE (Cursor, Claude Code, Windsurf, etc.) with a project opened and a terminal created to run brv commands

​
Step 1: Install

npm install -g byterover-cli
Verify the installation: 
brv --version

​
Step 2: Authenticate

Navigate to your project directory and start the ByteRover REPL: 
cd path/to/your/project
brv
You’ll see the Activity tab with a welcome message: ByteRover Activity Tab Press Tab to switch to the Console tab, then type: 
/login
ByteRover Console Login Follow the browser prompt to complete authentication.

​
Step 3: Initialize your project

In the Console tab, type: 
/init
You’ll complete a quick setup:
1

Select your team

2

Select your space

3

Choose your coding agent

After completing the setup, ByteRover will sync your remote context and generate rule files.

​
Step 4: Add your first context

​
Via your coding agent

Prompt your coding agent (Cursor, Claude Code, Windsurf, etc.): 
> Use brv curate command to curate essential contexts of this project's unit testing strategy. Make sure that unit tests run fast and run completely in memory.
Your coding agent will analyze the codebase and use brv curate to add context automatically. Switch to the Activity tab to view the operation in progress: Activity Tab - Curate Operation

​
Manual

In the Console tab, use the /curate command for more intentional curation: 
/curate make sure that unit tests run fast and run completely in memory
In this example, ByteRover organizes it into testing, one of the structured domains (structure, database, and backend, etc.) in the context tree.

​
Step 5: Verify it worked

Check your context tree with: 
/status
Check Status You’ll see your newly curated context added to the local context tree, ready to be synced to your remote space.

​
Step 6: Query context

​
Via your coding agent

Prompt your coding agent to retrieve context before implementing: 
> Use brv query command to check what unit testing strategies are in this project
Your coding agent will run brv query, asking what it needs for its task, and get the precise context. Activity Tab - Query Operation

​
Manual

In the Console tab, use the /query command: 
/query "What are unit testing strategies in this project?"
Switch to the Activity tab to view the operation in progress: Similarly, ByteRover retrieves the exact context curated earlier—unit testing strategies for the coding agent.
Codex users: Network access requiredCodex runs in a sandboxed mode without internet access by default. To use ByteRover CLI commands:
  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
You’re all set! You now know the core ByteRover commands. Continue learning how to collaborate with your team and integrate ByteRover into your complete workflow.

​
Next steps

Team Context Sync

Sync context with your team and see the complete workflow cycle

Curate Context

Learn best practices for adding context effectively

Query Context

Master context retrieval techniques

Onboard Context

Quick patterns for onboarding new projects