项目简介
Sourcebot 是一个针对您的代码库的快速代码索引和搜索工具。它构建在
zoekt
索引器之上，该索引器最初由 Han-Wen Nienhuys 编写，现在
由 Sourcegraph 维护
。
特征
-
💻
一命令部署
：立即开始在您自己的计算机上使用 Docker。
-
🔍
多存储库搜索
：轻松索引和搜索 GitHub 或 GitLab 中的多个公共和私有存储库。
-
⚡
闪电般的快速性能
：建立在强大的Zoekt搜索引擎之上。
-
📂
完整文件可视化
：选择任何搜索结果时立即查看整个文件。
-
🎨
现代网络应用程序
：享受时尚的界面，具有语法突出显示、浅色/深色模式和 vim 式导航等功能
您可以在这里尝试我们的公共托管演示！
入门
从单个 docker 命令开始：
docker run -p 3000:3000 --rm --name sourcebot ghcr.io/sourcebot-dev/sourcebot:latest
导航到
localhost:3000
开始搜索 Sourcebot 存储库。想搜索您自己的存储库吗？查看如何
配置 Sourcebot
。
配置Sourcebot
Sourcebot 支持通过托管的公共和私人存储库进行索引和搜索
GitHub 和
GitLab。本部分将指导您配置 Sourcebot 索引的存储库。
-
在您的计算机上创建一个新文件夹来存储您的配置和
.sourcebot
缓存，然后导航到其中：
mkdir sourcebot_workspacecd sourcebot_workspace
2. 按照配置模式创建一个新配置，以指定 Sourcebot 应索引哪些存储库。例如，索引llama.cpp ：
touch my_config.jsonecho '{ "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/index.json", "Configs": [ { "Type": "github", "GitHubUser": "ggerganov", "Name": "^llama\\.cpp$" } ]}' > my_config.json
3. 运行 Sourcebot 并将其指向您使用
-e CONFIG_PATH
标志创建的新配置：
docker run -p 3000:3000 --rm --name sourcebot -v $(pwd):/data -e CONFIG_PATH=/data/my_config.json ghcr.io/sourcebot-dev/sourcebot:latest
您应该在当前目录中看到一个
.sourcebot
文件夹。此文件夹存储 zoekt 已索引的存储库的缓存。存储库的
HEAD
提交每小时重新索引一次。索引私人回购？请参阅提供访问令牌。
[!警告] 根据存储库的大小，SourceBot 可能需要几分钟才能完成索引。SourceBot 目前不支持实时显示索引进度，因此请耐心等待。您可以通过调查工作区中的
.sourcebot
缓存来手动跟踪进度。
