byterover

ByteRover CLI - 上下文工程平台

ByteRover 是一个上下文工程平台，可让你为编码 Agent 精选上下文，包括模式、决策和经验。它会自动在团队成员之间同步上下文，并免去手动管理 Markdown 文件的麻烦。

配置

API 凭据存储在 ~/.clawdbot/byterover-config.json 中：

{
  "apiKey": "your_byterover_api_key_here",
  "team": "your_team_name",
  "space": "your_space_name"
}

基于 Docker 的用法

ByteRover CLI 需要 Node.js 20+ 和用于凭据存储的 libsecret。此技能使用 Docker 提供包含所有依赖项的隔离环境。

启动 ByteRover 容器

cd ~/.openclaw/workspace/skills/byterover
docker-compose up -d

在容器中运行命令

使用 API 密钥登录：

docker-compose exec byterover brv login --api-key $BRV_API_KEY

初始化项目：

docker-compose exec byterover brv init --headless --team "$BRV_TEAM" --space "$BRV_SPACE"

检查状态：

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 编码 Agent

向你的编码 Agent 提示：

使用 brv query 命令，检查此项目中使用了哪些身份验证模式

Agent 将执行：

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 Agent 集成

ByteRover 提供多种集成方式：

1. 技能文件（Claude Code、Cursor）

现代且易于发现的技能文件，Agent 可以检查并自动执行。

2. MCP 工具（通用）

适用于广泛 Agent 的模型上下文协议工具。

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 编码 Agent

故障排除

构建失败：

• 确保 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/