[!TIP] 请查看 zeitgrep，这是我正在开发的另一款搜索工具！

SeaGOAT

一款面向AI时代的代码搜索引擎。SeaGOAT是一款本地搜索工具，它利用向量嵌入技术，使您能够以语义方式搜索您的代码库。

开始使用

安装 SeaGOAT

为了安装 SeaGOAT，您需要在计算机上预先安装以下依赖项：

• Python 3.11 或更高版本
• ripgrep
• bat（可选，强烈推荐）

当 bat 已经安装后，只要启用了颜色显示功能，就会用它来展示结果。如果 SeaGOAT 被用作管道的一部分，则会采用 grep 样式的输出格式。当启用了颜色显示但未安装 bat 时，SeaGOAT 将使用 pygments 对输出进行高亮显示。建议使用 bat。

要使用 pipx 安装 SeaGOAT，请运行以下命令：

pipx install seagoat

系统要求

硬件

任何性能尚可的笔记本电脑都应该可以运行。

操作系统

SeaGOAT 设计为可在 Linux（已测试 ✅）、macOS（部分测试，寻求帮助）和 Windows（亟需帮助）上运行。

启动 SeaGOAT 服务器

要在您的项目中使用 SeaGOAT，您需要使用以下命令启动 SeaGOAT 服务器：

seagoat-server start /path/to/your/repo

搜索您的仓库

如果服务器正在运行，您可以直接使用 gt 或 seagoat 命令来查询您的仓库。例如：

gt "数字在哪里被四舍五入"

您还可以在查询中使用正则表达式，例如：

gt "处理税收的 calc_.* 函数"

停止服务器

您可以使用以下命令停止正在运行的服务器：

seagoat-server stop /path/to/your/repo

配置 SeaGOAT

SeaGOAT 可以通过 YAML 配置文件进行个性化设置，既可以全局配置，也可以针对特定项目使用 .seagoat.yml 文件。例如：

# .seagoat.yml

server:
  port: 31134  # 指定服务器端口

更多详细信息请参阅文档！

开发

要求：

• Poetry
• Python 3.11 或更高版本
• ripgrep

安装依赖

克隆仓库后，使用以下命令安装依赖：

poetry install

运行测试

监视模式（推荐）

poetry run ptw

测试更改过的文件

poetry run pytest .  --testmon

测试所有文件

poetry run pytest .

手动测试

您可以在本地开发环境中手动测试任何 SeaGOAT 命令。例如，要测试 seagoat-server 命令的开发版本，您可以运行：

poetry run seagoat-server start ~/path/an/example/repository

常见问题解答

本 FAQ 中的内容仅用于说明 SeaGOAT 的工作原理，并不构成法律合同。SeaGOAT 采用开源许可证，如果您对 SeaGOAT 的隐私、安全性等方面存在疑虑，欢迎查阅源代码、提出您的关切，或创建拉取请求来修复问题。

SeaGOAT 是如何工作的？它会将我的数据发送给 ChatGPT 吗？

SeaGOAT 不依赖第三方 API 或任何远程 API，所有功能都在本地通过您自己机器上运行的 SeaGOAT 服务器执行。

它没有依赖 API 或“连接到 ChatGPT”，而是使用名为 ChromaDB 的向量数据库，结合本地向量嵌入引擎，并且默认情况下禁用了遥测功能。

除此之外，SeaGOAT 还使用基于正则表达式的代码搜索引擎 ripgrep，以便在“基于 AI”的匹配之外，提供基于正则表达式或关键词的匹配。

虽然当前版本的 SeaGOAT 不会将您的数据发送到远程服务器，但未来可能会有可选的功能支持这一操作，前提是这样做能带来进一步的改进。

为什么 SeaGOAT 需要一个服务器？

SeaGOAT 需要服务器是为了提供快速响应。SeaGOAT 大量依赖向量嵌入和向量数据库，而目前这些技术还无法通过即时处理文件的架构来替代。

值得注意的是，您可以完全在本地运行 SeaGOAT 服务器，即使没有互联网连接也能正常工作。在这种情况下，您无需与远程服务器共享数据，可以直接在本地使用自己的 SeaGOAT 服务器；当然，如果您愿意，也可以运行一个 SeaGOAT 服务器，并允许其他计算机连接到它。

SeaGOAT 是否会生成由 AI 生成的作品？SeaGOAT 符合伦理吗？

如果您担心使用 AI 工具可能带来的伦理问题，请记住，SeaGOAT 并非代码生成器，而是一个代码搜索引擎，因此它不会生成 AI 生成的作品。

不过，确实有一个语言模型被用来生成向量嵌入。目前，SeaGOAT 使用 ChromaDB 的默认模型来计算向量嵌入，我不认为这会带来伦理上的担忧。

支持哪些编程语言？

目前，SeaGOAT 被硬编码为仅处理以下格式的文件：

• 文本文件 (*.txt)
• Markdown (*.md)
• Python (*.py)
• C (*.c, *.h)
• C++ (*.cpp, *.cc, *.cxx, *.hpp)
• TypeScript (*.ts, *.tsx)
• JavaScript (*.js, *.jsx)
• HTML (*.html)
• Go (*.go)
• Java (*.java)
• PHP (*.php)
• Ruby (*.rb)

为什么 SeaGOAT 处理文件的速度很慢，但 CPU 占用率却很低？

由于处理大型代码库中的文件可能需要较长时间，SeaGOAT 的设计目标之一就是让您在文件处理过程中仍能正常使用电脑。这是有意为之的设计选择，旨在避免阻塞或拖慢您的计算机。

这一设计决策并不会影响查询的性能。

顺便说一句，您可以在 SeaGOAT 处理文件的同时查询您的仓库！ 当您发起查询时，如果文件尚未处理完毕，系统会显示一条警告，告知您结果准确性的预估情况。此外，基于正则表达式或全文检索的结果会从一开始就显示出来！

支持哪些字符编码？

首选的字符编码是 UTF-8。大多数其他字符编码也应该可以正常工作。SeaGOAT 仅支持文本文件，会忽略二进制文件。

SeaGOAT 的数据库/缓存存储在何处？

SeaGOAT 数据库和缓存的具体存储位置取决于您的操作系统。为了方便起见，您可以使用 seagoat-server server-info 命令来查看这些文件在您系统上的存储路径。

我能否将 SeaGOAT 服务器部署在另一台计算机上？

可以。如果您不想在同一台计算机上运行 SeaGOAT 服务器，可以直接在另一台计算机或云端自托管 SeaGOAT 服务器，并通过互联网配置 seagoat 或 gt 命令以连接到该远程服务器。

请注意，SeaGOAT 本身并不强制实施任何安全措施，因为它主要是为本地运行而设计的。如果您有不希望泄露的私密代码，必须确保只有受信任的人员才能访问 SeaGOAT 服务器。这可以通过将其仅通过一个仅供团队成员访问的 VPN 网络来实现。

我可以忽略某些文件或目录吗？

SeaGOAT 已经会自动忽略 .gitignore 文件中指定的所有文件和目录。如果您希望进一步忽略某些文件，但又想让它们保留在 Git 仓库中，可以在服务器配置中使用 ignorePatterns 属性。了解更多

SeaGOAT 快速上手指南

SeaGOAT 是一款专为 AI 时代打造的本地代码搜索引擎。它利用向量嵌入（Vector Embeddings）技术，让你能够以语义化的方式搜索代码库，而不仅仅是关键词匹配。

环境准备

在开始之前，请确保你的系统满足以下要求：

系统要求

• 操作系统：推荐 Linux（已测试 ✅）。macOS 和 Windows 支持尚在完善中，可能需要额外调试。
• 硬件：任意主流笔记本电脑即可运行。

前置依赖

请预先安装以下工具：

• Python: 版本 3.11 或更高
• ripgrep: 用于基础文本搜索
• bat (可选但强烈推荐): 用于美化搜索结果输出。若未安装，SeaGOAT 将退化为使用 pygments 高亮。

提示：国内用户可使用镜像源加速 Python 包的安装（见下文）。

安装步骤

推荐使用 pipx 进行隔离安装，避免污染全局环境。

1. 安装 SeaGOAT

pipx install seagoat

国内加速方案：如果下载缓慢，可指定国内镜像源安装：

pipx install seagoat --pip-args '--index-url https://pypi.tuna.tsinghua.edu.cn/simple'

2. 验证安装

安装完成后，确保 seagoat 和 gt 命令可用。

基本使用

SeaGOAT 采用“服务端 + 客户端”架构。使用前需先启动本地服务器对代码库进行索引。

1. 启动服务器

进入你的项目根目录，运行以下命令启动 SeaGOAT 服务器（请将路径替换为实际项目路径）：

seagoat-server start /path/to/your/repo

注：首次运行时，服务器会后台处理文件并生成向量索引。此过程设计为低占用模式，你可以同时进行其他工作，甚至直接在处理完成前发起查询。

2. 执行语义搜索

服务器运行后，使用 gt 或 seagoat 命令进行自然语言搜索：

gt "Where are the numbers rounded"

SeaGOAT 也支持在自然语言中混合使用正则表达式：

gt "function calc_.* that deals with taxes"

3. 停止服务器

当你完成工作或需要释放资源时，可以停止服务器：

seagoat-server stop /path/to/your/repo

4. 进阶配置（可选）

你可以在项目根目录创建 .seagoat.yml 文件来自定义配置，例如修改服务器端口：

# .seagoat.yml
server:
  port: 31134