Documentation

[!NOTE] The documentation on the main branch reflects the code on the latest commit. To check for the documentation for the version you're using, you can check out the corresponding tags.

• For the setup and usage of the command-line tool, see the CLI documentation;
• For neovim users, after you've gone through the CLI documentation, please refer to the neovim plugin documentation (and optionally the lua API reference) for further instructions.
• Additional resources:
  • the wiki for extra tricks and tips that will help you get the most out of VectorCode;
  • the discussions where you can ask general questions and share your cool usages about VectorCode.
  • If you're feeling adanvturous, feel free to check out the pull requests for WIP features.

If you're trying to contribute to this project, take a look at the contribution guide, which contains information about some basic guidelines that you should follow and tips that you may find helpful.

About Versioning

This project follows an adapted semantic versioning:

• Until 1.0.0 is released, the major version number stays 0 which indicates that this project is still in early stage, and features/interfaces may change from time to time;
• The minor version number indicates breaking changes. When I decide to remove a feature/config option, the actual removal will happen when I bump the minor version number. Therefore, if you want to avoid breaking a working setup, you may choose to use a version constraint like "vectorcode<0.7.0";
• The patch version number indicates non-breaking changes. This can include new features and bug fixes. When I decide to deprecate things, I will make a new release with bumped patch version. Until the minor version number is bumped, the deprecated feature will still work but you'll see a warning. It's recommended to update your setup to adapt the new features.

TODOs

• [x] query by ~file path~ excluded paths;
• [x] chunking support;
  • [x] add metadata for files;
  • [x] chunk-size configuration;
  • [x] smarter chunking (semantics/syntax based), implemented with py-tree-sitter and tree-sitter-language-pack;
  • [x] configurable document selection from query results.
• [x] ~NeoVim Lua API with cache to skip the retrieval when a project has not been indexed~ Returns empty array instead;
• [x] job pool for async caching;
• [x] persistent-client;
• [ ] proper remote Chromadb support (with authentication, etc.);
• [x] respect .gitignore;
• [x] implement some sort of project-root anchors (such as .git or a custom .vectorcode.json) that enhances automatic project-root detection. Implemented project-level .vectorcode/ and .git as root anchor
• [x] ability to view and delete files in a collection;
• [x] joint search (kinda, using codecompanion.nvim/MCP);
• [x] Nix support (unofficial packages here);
• [ ] Query rewriting (#124).

Credit

• @milanglacier (and minuet-ai.nvim) for the support when this project was still in early stage;
• @olimorris for the help (personally and from codecompanion.nvim) when this project made initial attempts at tool-calling;
• @ravitemer for the help to interface VectorCode with MCP;
• The nix community (especially @sarahec and @GaetanLepage) for maintaining the nix packages.

Special Thanks

Star History