ByteRover 上下文树是一个项目级知识库,可在多次会话之间持久保存。它的用途是避免重复发现代码模式、约定和决策。
为什么使用 ByteRover
- 工作前查询:在实现之前获取关于模式、约定和过往决策的已有知识。
- 学习后整理:记录洞察、决策和缺陷修复,让未来的会话一开始就掌握信息。
快速参考
命令与使用时机:
- brv query "question":在开始工作前使用,例如 brv query "How is auth implemented?"
- brv curate "context" -f file:在完成工作后使用,例如 brv curate "JWT 24h expiry" -f auth.ts
- brv status:用于检查前置条件,例如 brv status
何时使用
当你需要理解某些内容时进行查询:
- "How does X work in this codebase?"
- "What patterns exist for Y?"
- "Are there conventions for Z?"
当你学到或创建了有价值的内容时进行整理:
- 使用特定模式实现了某个功能
- 修复了缺陷并找到根本原因
- 做出了架构决策
整理质量
上下文必须具体且可操作:
好的示例——具体,说明位置和原因: brv curate "Auth uses JWT 24h expiry, tokens in httpOnly cookies" -f src/auth.ts
差的示例——过于模糊: brv curate "Fixed auth"
注意:context 参数必须放在 -f 标志之前。最多 5 个文件。
最佳实践
拆分大型上下文——对于复杂主题,运行多个 brv curate 命令,而不是一个庞大的上下文。更小的块更容易检索和更新。
让 ByteRover 读取文件——在整理之前不要自己读取文件。使用 -f 标志让 ByteRover 直接读取它们:
好的示例——ByteRover 读取文件: brv curate "Auth implementation details" -f src/auth.ts -f src/middleware/jwt.ts
浪费的做法——读取文件两次:
[agent reads files] then brv curate "..." -f same-files
查询要具体——查询会阻塞你的工作流。使用精确的问题以获得更快、更相关的结果:
好的示例——具体: brv query "What validation library is used for API request schemas?"
差的示例——模糊、缓慢: brv query "How is validation done?"
标记过时上下文——当整理替换已有知识的更新时,明确告诉 ByteRover 进行清理: brv curate "OUTDATED: Previous auth used sessions. NEW: Now uses JWT with refresh tokens. Clean up old session-based auth context." -f src/auth.ts
指定结构期望——指导 ByteRover 如何组织知识:
指定主题/领域: brv curate "Create separate topics for: 1) JWT validation, 2) refresh token flow, 3) logout handling" -f src/auth.ts
指定详细程度: brv curate "Document the error handling patterns in detail (at least 30 lines covering all error types)" -f src/errors/
前置条件
先运行 brv status。如果出现错误,智能体无法修复它们——应指示用户在 brv 终端中采取行动。详情参见 TROUBLESHOOTING.md。
另见:WORKFLOWS.md 了解详细模式和示例,TROUBLESHOOTING.md 了解错误处理。