# @byterover/brv-bridge 中文文档

规范地址：https://npmcn.com/package/%40byterover/brv-bridge/

版本：1\.2\.0
npm 元数据更新时间：2026-07-05T03:44:45.027Z
中文译文更新时间：2026-11-08T22:04:29.032Z
软件包许可：Elastic-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40byterover/brv-bridge
原文对照：https://npmcn.com/package/%40byterover/brv-bridge/?lang=original
项目主页：https://github.com/campfirein/brv-bridge#readme
源码仓库：https://github.com/campfirein/brv-bridge

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：48.4 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-04-02T09:23:25.322Z
- 最新版本发布：2026-05-06T08:26:21.491Z
- 近 30 天下载量：4168（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

连接代理框架到 ByteRover 上下文树的标准界面.

## 安装

```sh
npm install @byterover/brv-bridge
```

也可以使用：`pnpm add @byterover/brv-bridge`、`yarn add @byterover/brv-bridge`、`bun add @byterover/brv-bridge`

## README

# 桥桥

连接代理框架的标准接口 [字节旋转](https://www.byterover.dev/)'上下文树.

任何执行桥接的代理设备,在转弯前可以免费分享背景知识,在转弯后可以坚持新的知识,并在上下文树上搜索结构化的文件结果.

## 安装

```bash
npm install @byterover/brv-bridge
```

**先决条件:** [字节Rover CLI](https://www.byterover.dev/) 安装并初始化空间.

## 使用量

```typescript
import { BrvBridge } from "@byterover/brv-bridge";

const bridge = new BrvBridge({ cwd: "/path/to/project" });

// Check if brv is set up
if (await bridge.ready()) {
  // Retrieve relevant context (synthesized answer)
  const { content } = await bridge.recall("what did we decide about auth?");

  // Search for structured file results (paths, scores, excerpts)
  const { results } = await bridge.search("authentication");
  for (const r of results) {
    console.log(`${r.title} [${r.score}] — ${r.path}`);
  }

  // Store knowledge
  await bridge.persist("User prefers JWT over session cookies");
}

// Clean up
await bridge.shutdown();
```

## API 密码

### `new BrvBridge(config)`

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `cwd` | `string` | `process.cwd()` | 工作目录 `.brv/` 已初始化 |
| `brvPath` | `string` | `"brv"` | BRV 二进制路径 |
| `recallTimeoutMs` | `number` | `10000` | 召回行动超时 |
| `persistTimeoutMs` | `number` | `60000` | 持续作业的超时 |
| `searchTimeoutMs` | `number` | `5000` | 搜索操作超时 |
| `logger` | `BrvLogger` | 无 -op | Logger 实例 |

### `bridge.ready(): Promise<boolean>`

检查桥是否配置——验证 `cwd` 已存在并有 `.brv` 目录。 不进行网络通话.

### `bridge.recall(query, options?): Promise<RecallResult>`

从上下文树获取相关上下文 。 回返 `{ content: "" }` ——永远不要扔出.

选项 : `signal` (AbortSignal), (美国英语), `cwd` (每召总.

### `bridge.persist(context, options?): Promise<PersistResult>`

将上下文存储到上下文树上。 默认拆分模式(fire- and-forget). 回返 `{ status, message? }`。 。 。 .

选项 : `detach` (默认) `true`, (中文(简体) ), `cwd` (每召总.

### `bridge.search(query, options?): Promise<SearchResult>`

搜索上下文树以获取结构化文件结果 。 按路径、分数和节选对结果进行排序。 纯BM25检索 - 没有LLM,没有符号成本.

与 `recall()` 它返回一个合成的答案, `search()` 返回单个文件级结果.

选项 : `limit` (默认) `10`最大点 `50`, (中文(简体) ), `scope` (路径前缀, 没有后侧斜线), `cwd` (每召总.

```typescript
const { results, totalFound } = await bridge.search("authentication", {
  limit: 5,
  scope: "auth",
});
// results: [{ path, title, excerpt, score, symbolKind?, backlinkCount? }]
```

### `bridge.shutdown(): Promise<void>`

清理资源. 适配器应该称之为前向相容.

## 对于适配器作者

该桥被设计成由框架特有的适配器所包裹. 每个适配器绘制其框架的生命周期钩到 `recall()`, (中文(简体) ), `persist()`,以及 `search()`数字 :

```typescript
// OpenClaw adapter example
class ByteRoverContextEngine {
  private bridge = new BrvBridge({ cwd, logger });

  async assemble(params) {
    const { content } = await this.bridge.recall(query);
    // inject content into system prompt
  }

  async afterTurn(params) {
    await this.bridge.persist(serializedConversation);
  }
}
```

## 许可证

[弹性许可证2.0(ELv2)](https://npmcn.com/package/%40byterover/brv-bridge/LICENSE)

## 常见问题

### @byterover/brv-bridge 是什么？

连接代理框架到 ByteRover 上下文树的标准界面\.

### 如何安装 @byterover/brv-bridge？

在项目目录运行 npm install @byterover/brv-bridge，或使用 pnpm add / yarn add / bun add。

### @byterover/brv-bridge 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @byterover/brv-bridge 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @byterover/brv-bridge 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @byterover/brv-bridge 可以商用吗？

@byterover/brv-bridge 使用 Elastic-2\.0 许可。声明的许可为 Elastic-2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @byterover/brv-bridge 的下载量有多少？

根据 npm 官方下载统计，@byterover/brv-bridge 在 2026/10/09 – 2026/11/07 这 30 天内被下载 4,168 次，日均约 139 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @byterover/brv-bridge 还在维护吗？

最新版本 1\.2\.0 发布于 2026/05/06（6 个月前）；至今共发布 5 个版本，其中过去 12 个月发布了 5 个；首次发布于 2026/04/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。