名称: byterover
描述: "使用 ByteRover 上下文树管理项目知识。提供两种操作:查询(检索知识)和整理(存储知识)。当用户请求信息查找、模式发现或知识持久化时调用。由 ByteRover Inc. (https://byterover.dev/) 开发。"
元数据:
author: ByteRover Inc. (https://byterover.dev/)
version: "1.2.1"
一个跨会话持久化的项目级知识库。用于避免重复发现模式、约定和决策。
| 命令 | 使用时机 | 示例 |
|---|---|---|
brv query "问题" |
开始工作前 | brv query "认证是如何实现的?" |
brv curate "上下文" -f 文件 |
完成工作后 | brv curate "JWT 24小时过期" -f auth.ts |
brv status |
检查前置条件 | brv status |
查询 当你需要理解某些内容时:
- "X 在这个代码库中是如何工作的?"
- "Y 存在哪些模式?"
- "Z 是否有约定?"
整理 当你学到或创造了有价值的内容时:
- 使用特定模式实现了一个功能
- 修复了一个 Bug 并找到了根本原因
- 做出了架构决策
上下文必须具体且可操作:
# 良好 - 具体,说明了位置和原因
brv curate "认证使用 JWT 24小时过期,令牌存储在 httpOnly cookie 中" -f src/auth.ts
# 不佳 - 过于模糊
brv curate "修复了认证"
注意: 上下文参数必须在 -f 标志之前。最多关联 5 个文件。
分解大型上下文 - 对于复杂主题,运行多个 brv curate 命令,而不是一个庞大的上下文。较小的块更容易检索和更新。
让 ByteRover 读取文件 - 在整理前不要自己读取文件。使用 -f 标志让 ByteRover 直接读取:
```bash
# 良好 - ByteRover 读取文件
brv curate "认证实现细节" -f src/auth.ts -f src/middleware/jwt.ts
```
查询要具体 - 查询会阻塞你的工作流。使用精确的问题以获得更快、更相关的结果:
```bash
# 良好 - 具体
brv query "API 请求模式使用了哪个验证库?"
brv query "验证是怎么做的?"
```
标记过时上下文 - 当整理更新以替换现有知识时,明确告知 ByteRover 进行清理:
bash
brv curate "已过时:之前的认证使用会话。新方案:现在使用 JWT 和刷新令牌。请清理旧的基于会话的认证上下文。" -f src/auth.ts
指定结构期望 - 指导 ByteRover 如何组织知识:
```bash
# 指定主题/领域
brv curate "创建独立的主题:1) JWT 验证,2) 刷新令牌流程,3) 注销处理" -f src/auth.ts
brv curate "详细记录错误处理模式(至少 30 行,涵盖所有错误类型)" -f src/errors/
```
首先运行 brv status。如果出现错误,代理无法修复——请指导用户在他们的 brv 终端中采取行动。详情参见 TROUBLESHOOTING.md。
另请参阅: WORKFLOWS.md 获取详细模式和示例,TROUBLESHOOTING.md 获取错误处理信息