Bloop 快速上手教程（GitHub README 中文整理）

是什么

Bloop 是一个面向开发者的 AI 代码助手，可以理解为你代码库专属的 ChatGPT。它基于 Rust 生态构建，底层使用 Tantivy 和 Qdrant 进行搜索索引，前端采用 Tauri 框架开发跨平台桌面应用。Bloop 支持本地语义搜索，注重隐私保护，所有嵌入计算均在设备端完成。

能干什么

Bloop 可以帮助你：

• 用自然语言解释代码文件或功能的工作原理
• 基于现有代码上下文编写新功能
• 理解文档不全的开源库用法
• 精准定位代码错误
• 用中文提问英文代码库的问题
• 通过检查已有功能减少重复代码

核心功能包括：

• AI 对话式搜索：用自然语言提问，Bloop 结合你的代码库给出回答
• Code Studio：一个 LLM 游乐场，自动使用你的代码作为上下文
• 正则搜索：极速的正则表达式搜索
• 符号搜索：快速定位函数、变量或 trait
• 代码导航：基于 Tree-sitter 实现 10+ 主流语言的跳转到定义和引用
• 智能过滤：多种查询过滤器缩小结果范围

怎么装

方式一：下载安装包（推荐）

直接前往 GitHub Releases 页面 下载对应系统的安装包，按引导完成安装即可。

方式二：从源码构建

1. 克隆仓库并切换到 oss 分支：

git clone https://github.com/BloopAI/bloop.git
cd bloop
git checkout oss

2. 在仓库根目录创建 local_config.json，填入你的 API 密钥：

{
    "github_access_token": "<YOUR_GITHUB_ACCESS_TOKEN>",
    "openai_api_key": "<YOUR_OPENAI_API_KEY>"
}

3. 安装 Git LFS 并拉取依赖：

git lfs install
git lfs pull

4. 按照 桌面端构建指南 完成构建。

从源码构建的版本不会收集任何遥测数据。

怎么用第一个例子

安装完成后，启动 Bloop，你会看到主界面。以下是第一个典型使用场景：

场景：你想了解项目中某个函数的作用

1. 在搜索框中输入自然语言问题，例如：

   解释一下 src/utils/parser.rs 中的 parse_config 函数
   

2. Bloop 会分析该函数及其上下文，用简单语言给出解释
3. 你还可以追问：

   这个函数有哪些调用者？
   

场景：查找已有功能避免重复

1. 输入：

   项目中是否已经有用户登录相关的代码？
   

2. Bloop 会搜索整个代码库，返回相关文件和代码片段

社区资源

• 项目主页：https://bloop.ai
• GitHub 仓库：https://github.com/BloopAI/bloop
• 官方文档：
  • 快速入门指南
  • 自然语言查询参考
  • 正则搜索参考
  • Code Studio 使用说明
• 贡献指南：请阅读 CONTRIBUTING.md 和 行为准则
• 反馈问题：在 GitHub 上 提交 Issue

翻译整理自 GitHub README，原文：https://github.com/BloopAI/bloop