VectorCode

VectorCode 是一个代码仓库索引工具。它通过索引并提供关于您正在处理的代码仓库的信息，帮助您为您的代码 LLM 编写更好的提示词。这个仓库也包含了相应的 neovim 插件，因为这是我用来编写这个工具的。

[!NOTE] 这个项目目前处于 beta 质量，只实现了非常基本的检索和嵌入功能。还有很大的改进空间，欢迎任何帮助。

[!NOTE] Chromadb，这个项目背后的向量数据库后端，支持多种嵌入引擎。我使用 SentenceTransformer 开发了这个工具，但是如果您在使用不同的嵌入函数时遇到任何问题，请提出 issue（或者更好的是，提交一个 pull request :D）。

<!-- mtoc-start -->

• 为什么选择 VectorCode？
• 文档
• TODOs
• 致谢

<!-- mtoc-end -->

为什么选择 VectorCode？

LLM 通常对闭源项目、不太知名的项目以及尚未发布的前沿开发成果的理解非常有限。它们在这些项目上的能力非常有限。以我的小型玩具数独求解项目为例：当我编写了前几行代码并希望 LLM 填写我在 solver_candidates 中实现的求解器列表时，如果没有项目上下文，补全结果只是随机猜测，可能是另一个数独项目的一部分： 但是，通过 VectorCode 提供的 RAG 上下文，我的补全 LLM 能够提供我实际实现的补全结果： 这使得补全结果更加可用。一个类似的策略 在 continue 中实现，这是一个流行的 AI 补全和聊天插件，可在 VSCode 和 JetBrain 产品上使用。

文档

[!NOTE] main 分支上的文档反映了最新提交的代码（如果我忘记更新文档，请见谅，但这是我的目标）。要查看您正在使用的版本的文档，您可以查看相应的标签。

• 有关命令行工具的设置和使用，请参阅 CLI 文档；
• 对于 neovim 用户，在您阅读完 CLI 文档后，请参阅 neovim 插件文档 以获取更多说明。

如果您想为这个项目做出贡献，请查看 贡献指南，其中包含有关您应该遵循的一些基本准则以及您可能会发现有用的提示的信息。

TODOs

• [x] 按 ~文件路径~ 排除路径查询；
• [x] 分块支持；
  • [x] 添加文件元数据；
  • [x] 分块大小配置；
  • [x] 更智能的分块（基于语义/语法），使用 py-tree-sitter 和 tree-sitter-language-pack 实现；
  • [x] 可配置的查询结果文档选择。
• [x] ~带有缓存的 NeoVim Lua API，用于跳过未索引项目的检索~ 返回空数组代替；
• [x] 用于异步缓存的作业池；
• [x] 持久客户端；
• [-] 适当的 远程 Chromadb 支持（带有身份验证等）；
• [x] 尊重 .gitignore；
• [x] 实现某种项目根目录锚点（例如 .git 或自定义的 .vectorcode.json），以增强自动项目根目录检测。已实现项目级别的 .vectorcode/ 和 .git 作为根锚点
• [ ] 能够查看和删除集合中的文件（目前您只能 drop 并再次 vectorise）；
• [x] 联合搜索（某种程度上，使用 codecompanion.nvim/MCP）。

致谢

• 感谢 @milanglacier（和 minuet-ai.nvim）在这个项目还处于早期阶段时的支持；
• 感谢 @olimorris 在这个项目最初尝试工具调用时提供的帮助（亲自和来自 codecompanion.nvim）；
• 感谢 @ravitemer 帮助 VectorCode 与 MCP 连接。