ByteRover 知识管理

使用brv命令行工具来管理您自己的知识库。ByteRover 维护一个上下文树，用于存储项目的模式、决策和实现细节。

重要提示：对于无头/自动化使用，请始终添加--headless --format json标志以获取机器可解析的 JSON 输出。

设置（无头模式）

• ByteRover 可以在无头模式下完全设置。如果用户尚未登录或在当前工作目录中初始化.brv/（可通过projectInitialized和authStatus在brv status --headless --format json的响应中进行检查），请要求他们提供：

1. API 密钥- 用于身份验证（从https://app.byterover.dev/settings/keys团队与空间
2. - 用于项目初始化的名称或ID使用API密钥登录

使用API密钥进行身份验证：

输出文本：

brv login --api-key <key>

以<邮箱>身份登录成功后。初始化项目

为项目初始化ByteRover（无头模式需要团队和空间 - 可使用ID或名称）：

强制重新初始化：

# Using names
brv init --headless --team my-team --space my-space --format json

# Using IDs
brv init --headless --team team-abc123 --space space-xyz789 --format json

示例响应：

brv init --headless --team my-team --space my-space --force --format json

注意

{
  "success": true,
  "command": "init",
  "data": {
    "status": "success",
    "teamName": "MyTeam",
    "spaceName": "MySpace",
    "configPath": "/path/to/project/.brv/config.json"
  }
}

：您可以使用团队/空间名称或ID。名称匹配不区分大小写。检查状态

检查ByteRover和项目的当前状态：

示例响应：

brv status --headless --format json

查询知识

{
  "success": true,
  "command": "status",
  "data": {
    "cliVersion": "1.0.0",
    "authStatus": "logged_in",
    "userEmail": "user@example.com",
    "projectInitialized": true,
    "teamName": "MyTeam",
    "spaceName": "MySpace",
    "mcpStatus": "connected",
    "contextTreeStatus": "has_changes"
  }
}

提出问题以检索相关知识：

示例响应：

brv query "How is authentication implemented?" --headless --format json

整理上下文

{
  "success": true,
  "command": "query",
  "data": {
    "status": "completed",
    "result": "Authentication uses JWT tokens...",
    "toolCalls": [{"tool": "search_knowledge", "status": "success", "summary": "5 matches"}]
  }
}

Curate Context

向项目的上下文树添加新知识或上下文：

brv curate "Auth uses JWT with 24h expiry. Tokens stored in httpOnly cookies via authMiddleware.ts" --headless --format json

包含具体文件以实现全面的上下文覆盖（最多5个文件）：

brv curate "Authentication middleware validates JWT tokens" --files src/middleware/auth.ts --headless --format json

示例响应：

{
  "success": true,
  "command": "curate",
  "data": {
    "status": "queued",
    "taskId": "abc123",
    "message": "Context queued for processing"
  }
}

推送上下文树

将本地上下文树的更改推送到ByteRover云存储：

brv push --headless --format json -y

该-y标志用于跳过确认提示（无头模式下必需）。

推送到特定分支：

brv push --branch feature-branch --headless --format json -y

示例响应：

{
  "success": true,
  "command": "push",
  "data": {
    "status": "success",
    "added": 3,
    "edited": 1,
    "deleted": 0,
    "branch": "main",
    "url": "https://app.byterover.com/team/space"
  }
}

可能的状态：

• 成功- 推送完成
• 无更改- 无上下文更改需要推送
• 已取消- 推送被取消
• 错误- 推送失败

拉取上下文树

从ByteRover云存储拉取上下文树：

brv pull --headless --format json

从特定分支拉取：

brv pull --branch feature-branch --headless --format json

示例响应：

{
  "success": true,
  "command": "pull",
  "data": {
    "status": "success",
    "added": 5,
    "edited": 2,
    "deleted": 1,
    "branch": "main",
    "commitSha": "abc123def"
  }
}

可能的状态：

• 成功- 拉取操作已完成
• 本地变更- 存在本地变更，请先推送
• 错误- 拉取操作失败

错误处理

请始终检查successJSON响应中的字段：

• success: true- 操作成功完成
• success: false- 操作失败，请检查data.error或data.message以获取详细信息

常见错误场景：

• 未认证：请运行brv login --api-key <密钥>
• 项目未初始化运行brv init --headless --team <团队> --space <空间> --format json
• 存在本地更改：拉取前先推送本地更改

提示

1. 对于拉取和推送操作，您应该先征求用户许可。
2. 始终使用--headless --format json进行自动化操作（除了brv login命令，它输出文本）。
3. 首先检查brv status --headless --format json以验证身份验证和项目状态。
4. 对于整理操作，请使用--files包含相关文件以获取更好的上下文。
5. 查询响应可能包含工具调用详情，显示搜索了哪些知识。
6. 对于推送操作，始终使用-y以在无头模式下跳过确认。对于重新初始化，请使用-f强制重新初始化。
7. 如果存在未推送的本地更改，拉取操作将失败 - 请先推送。