docker-compose exec byterover brv status --headless --format json

查询上下文：

docker-compose exec byterover brv query "What are the testing strategies?" --headless --format json

整理上下文：

docker-compose exec byterover brv curate "Make sure to document API authentication patterns" --headless --format json

推送更改：

docker-compose exec byterover brv push --headless --format json

拉取更改：

docker-compose exec byterover brv pull --headless --format json

无头模式

ByteRover CLI 支持无头模式以用于自动化和脚本编写。无头模式禁用交互式提示，并支持机器可读的 JSON 输出。

支持 --headless 的命令

• brv init (需要 --team 和 --space)
• brv status
• brv query
• brv curate
• brv push (自动跳过确认)
• brv pull

输出格式

使用 --format 控制输出：

• text (默认)：人类可读的文本输出
• json：用于机器解析的 NDJSON (换行分隔的 JSON)

API 密钥认证

对于无头环境，使用 API 密钥代替 OAuth 浏览器流程：

brv login --api-key $BRV_API_KEY

上下文树

上下文树 是 ByteRover 的结构化知识系统，它将项目上下文组织到各个领域：

• 结构 - 项目架构和模式
• 数据库 - 模式、迁移、关系
• 后端 - API 端点、业务逻辑
• 前端 - UI 组件、状态管理
• 测试 - 测试策略、测试夹具
• 部署 - 基础设施、CI/CD
• 文档 - 指南、API 文档

使用示例

对于 AI 编码智能体

提示您的编码智能体：

使用 brv query 命令检查此项目中使用了哪些认证模式

智能体将执行：

brv query "What authentication patterns are used?" --headless --format json

手动使用

检查项目状态：

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv status

从终端添加上下文：

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv curate "Document the API rate limiting strategy"

查询特定知识：

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv query "How do we handle rate limiting?"

辅助脚本

快速状态检查

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/status.sh

CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv status --headless --format json

查询上下文

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/query.sh

QUERY="${1:-project overview}"
CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv query "$QUERY" --headless --format json

添加上下文

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/curate.sh

CONTEXT="${1}"
CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv curate "$CONTEXT" --headless --format json

同步更改

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/sync.sh

CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover

echo "Pulling latest context..."
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv pull --headless --format json

echo "Pushing local changes..."
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv push --headless --format json

Docker 管理

构建镜像：

cd ~/.openclaw/workspace/skills/byterover
docker-compose build

启动容器：

docker-compose up -d

停止容器：

docker-compose down

查看日志：

docker-compose logs -f

进入容器 shell：

docker-compose exec byterover bash

与 AI 智能体集成

ByteRover 提供多种集成方法：

1. 技能文件 (Claude Code, Cursor)

现代、可发现的技能文件，智能体可以自动检查和执行。

2. MCP 工具 (通用)

用于广泛智能体兼容性的模型上下文协议工具。

3. 基于规则 (旧版)

为旧版集成生成的规则文件。

JSON 输出结构

NDJSON 格式，包含消息类型：

• log：进度消息
• output：主要输出内容
• error：错误消息
• warning：警告消息
• result：最终操作结果

环境变量

• BRV_API_KEY - ByteRover API 密钥
• BRV_TEAM - 团队名称
• BRV_SPACE - 空间名称
• BRV_HEADLESS - 启用无头模式 (true)
• BRV_FORMAT - 输出格式 (json/text)

注意事项

• ByteRover 首次设置需要基于浏览器的 OAuth 流程
• API 密钥认证为无头环境绕过了 OAuth
• 上下文会在团队成员间自动同步
• 不会让 Markdown 文件杂乱您的代码库
• 可与 19+ 个 AI 编码智能体配合工作

故障排除

构建失败：

• 确保 Docker 守护进程正在运行
• 检查端口 80/443 是否可用

登录失败：

• 验证 API 密钥是否有效
• 检查团队和空间名称是否正确

容器退出：

• 检查日志：docker-compose logs
• 确保 /workspace 已正确挂载

查询无结果：

• 使用 brv init 初始化项目
• 使用 brv curate 添加上下文
• 使用 brv pull 同步

要求

• Docker
• Docker Compose
• ByteRover 账户
• 活跃的团队和空间

许可证

MIT

作者

由 Jun Suzuki 为 OpenClaw 创建

有关 ByteRover 的更多信息，请访问：https://docs.byterover.dev/

每周安装数

135

代码仓库

junsuzuki1973/o…yterover

首次出现

2026年2月15日

安全审计

Gen Agent Trust HubFailSocketPassSnykPass

安装于

gemini-cli132

github-copilot130

opencode130

codex129

openclaw129

cursor129

Check Status:

docker-compose exec byterover brv status --headless --format json

Query Context:

docker-compose exec byterover brv query "What are the testing strategies?" --headless --format json

Curate Context:

docker-compose exec byterover brv curate "Make sure to document API authentication patterns" --headless --format json

Push Changes:

docker-compose exec byterover brv push --headless --format json

Pull Changes:

docker-compose exec byterover brv pull --headless --format json

Headless Mode

ByteRover CLI supports headless mode for automation and scripting. Headless mode disables interactive prompts and supports machine-readable JSON output.

Supported Commands with --headless

• brv init (requires --team and --space)
• brv status
• brv query
• brv curate
• brv push (auto-skips confirmation)
• brv pull

Output Formats

Use --format to control output:

• text (default): Human-readable text output
• json: NDJSON (newline-delimited JSON) for machine parsing

API Key Authentication

Instead of OAuth browser flow, use API key for headless environments:

brv login --api-key $BRV_API_KEY

Context Tree

The Context Tree is ByteRover's structured knowledge system that organizes project context into domains:

• Structure - Project architecture and patterns
• Database - Schema, migrations, relationships
• Backend - API endpoints, business logic
• Frontend - UI components, state management
• Testing - Test strategies, fixtures
• Deployment - Infrastructure, CI/CD
• Documentation - Guides, API docs

Usage Examples

For AI Coding Agents

Prompt your coding agent:

Use brv query command to check what authentication patterns are used in this project

Agent will execute:

brv query "What authentication patterns are used?" --headless --format json

Manual Usage

Check project status:

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv status

Add context from terminal:

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv curate "Document the API rate limiting strategy"

Query specific knowledge:

~/.openclaw/workspace/skills/byterover/docker-compose exec byterover brv query "How do we handle rate limiting?"

Helper Scripts

Quick Status Check

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/status.sh

CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv status --headless --format json

Query Context

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/query.sh

QUERY="${1:-project overview}"
CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv query "$QUERY" --headless --format json

Add Context

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/curate.sh

CONTEXT="${1}"
CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv curate "$CONTEXT" --headless --format json

Sync Changes

#!/bin/bash
# ~/.openclaw/workspace/skills/byterover/scripts/sync.sh

CONFIG=$(cat ~/.clawdbot/byterover-config.json)
API_KEY=$(echo "$CONFIG" | jq -r '.apiKey')
TEAM=$(echo "$CONFIG" | jq -r '.team')
SPACE=$(echo "$CONFIG" | jq -r '.space')

cd ~/.openclaw/workspace/skills/byterover

echo "Pulling latest context..."
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv pull --headless --format json

echo "Pushing local changes..."
BRV_API_KEY="$API_KEY" BRV_TEAM="$TEAM" BRV_SPACE="$SPACE" \
  docker-compose exec -T byterover brv push --headless --format json

Docker Management

Build image:

cd ~/.openclaw/workspace/skills/byterover
docker-compose build

Start container:

docker-compose up -d

Stop container:

docker-compose down

View logs:

docker-compose logs -f

Enter container shell:

docker-compose exec byterover bash

Integration with AI Agents

ByteRover provides multiple integration methods:

1. Skill Files (Claude Code, Cursor)

Modern, discoverable skill files that agents can inspect and execute automatically.

2. MCP Tools (Universal)

Model Context Protocol tools for broad agent compatibility.

3. Rules-Based (Legacy)

Generated rule files for older integrations.

JSON Output Structure

NDJSON format with message types:

• log: Progress messages
• output: Main output content
• error: Error messages
• warning: Warning messages
• result: Final operation result

Environment Variables

• BRV_API_KEY - ByteRover API key
• BRV_TEAM - Team name
• BRV_SPACE - Space name
• BRV_HEADLESS - Enable headless mode (true)
• BRV_FORMAT - Output format (json/text)

Notes

• ByteRover requires a browser-based OAuth flow for first-time setup
• API key authentication bypasses OAuth for headless environments
• Context is automatically synced across team members
• No markdown files cluttering your codebase
• Works with 19+ AI coding agents

Troubleshooting

Build fails:

• Ensure Docker daemon is running
• Check that port 80/443 is available

Login fails:

• Verify API key is valid
• Check team and space names are correct

Container exits:

• Check logs: docker-compose logs
• Ensure /workspace is mounted correctly

Query returns no results:

• Initialize project with brv init
• Add context with brv curate
• Sync with brv pull

Requirements

• Docker
• Docker Compose
• ByteRover account
• Active team and space

License

MIT

Author

Created for OpenClaw by Jun Suzuki

For more information about ByteRover, visit: https://docs.byterover.dev/

Weekly Installs

135

Repository

junsuzuki1973/o…yterover

First Seen

Feb 15, 2026

Security Audits

Gen Agent Trust HubFailSocketPassSnykPass

Installed on

gemini-cli132

github-copilot130

opencode130

codex129

openclaw129

cursor129