\r

ContextBridge 知识库\r

\r

📚 工作原理\r

\r ContextBridge 为 OpenClaw 提供对你本地文档（Word、Excel、PDF、Markdown）的即时检索能力。\r \r

1. 本地索引：扫描文档并将文本切分为文本块。\r
2. 向量化：使用本地 AI 嵌入模型将文本转换为语义向量。\r
3. 语义搜索：从知识库中匹配最相关的文本块。\r \r ---\r \r

🚀 下载安装\r

\r cbridge 安装与初始化流程\r \r

flowchart TD\r
    A([开始]) --> B{已安装 cbridge？\
cbridge --version}\r
\r
    B -- 是 --> C[检测更新\
cbridge update]\r
    C --> D{需要重新初始化？\
询问用户}\r
    D -- 是 --> E[重新初始化配置\
cbridge init]\r
    D -- 否 --> G\r
    E --> G\r
\r
    B -- 否 --> F1[说明需安装 ContextBridge\
用于监控本地目录、向量化文件]\r
    F1 --> F2[说明工作目录\
创建 ~/.cbridge 保存工作文件]\r
    F2 --> F3[获取用户授权\
自动完成下载与初始化]\r
    F3 --> G\r
\r
    G[配置完成\
通过 cbridge 与 ContextBridge 交互] --> H[运行内置 Demo\
cbridge search ContextBridge]\r
    H --> I([结束])\r
```\r
\r
### 1. 下载\r
\r
> 🔓 **开源可信**：`cbridge-agent` 完全开源，代码托管于 [GitHub](https://github.com/whyischen/context-bridge)，可审计验证，本地运行无数据泄露风险。\r
\r
```bash\r
pip install cbridge-agent\r
```\r
\r
### 2. 初始化配置\r
\r
```bash\r
cbridge init\r
```\r
\r
因为软件主要为 AI 工具调用，推荐用户全部使用默认配置\r
\r
### 3. 添加文档\r
\r
```bash\r
cbridge watch add /path/to/your/documents\r
cbridge watch list    # 查看已监听文件夹\r
```\r
\r
### 4. 运行测试 demo\r
\r
```bash\r
cbridge search ContextBridge    # 搜索内置测试文档\r
```\r
\r
---\r
\r
## 💡 搜索最佳实践\r
\r
1. 尽量做到无感使用，根据用户语义判断使用调用 `cbridge seatch` 检索本地内容\r
2. `cbridge seatch` 会返回与搜索相关的**文档片段**以及**文档路径**，根据文档片段**判断是否需要获取文档全部内容**。\r
\r
### 什么时候使用 ContextBridge\r
\r
1. 分析用户所提到的资料可能是内部资料时\r
2. 用户明确提出查看本地文档时\r
\r
### 关键词提取\r
\r
- 推荐：提取核心实体\r
  - `2024 marketing budget` ✅\r
- 不推荐：使用完整句子\r
  - `What was the budget for 2024 marketing` ❌\r
\r
### 迭代搜索\r
\r
1. 先用精准关键词\r
2. 若无结果，扩大查询范围\r
3. 尝试同义词或相关术语\r
\r
---\r
\r
## 📖 CLI 命令\r
\r
```bash\r
# 初始化\r
cbridge init                 # 初始化工作区\r
cbridge lang en              # 切换语言\r
\r
# 文档管理\r
cbridge watch add path     # 添加文件夹\r
cbridge watch remove path  # 移除文件夹\r
cbridge watch list           # 列出文件夹\r
cbridge index                # 手动重建索引\r
\r
# 服务控制\r
cbridge start                # 启动服务\r
cbridge serve                # 仅启动 API\r
cbridge stop                 # 停止服务\r
cbridge status               # 查看状态\r
cbridge logs                 # 查看日志\r
\r
# 搜索\r
cbridge search query       # 搜索文档\r
```\r
\r
---\r
\r
## 📚 资源链接\r
\r
- GitHub：[whyischen/context-bridge](https://github.com/whyischen/context-bridge)\r
- 配置文件：`~.cbridgeconfig.yaml`\r
- 工作区：`~.cbridgeworkspace`\r