Skip to content
Back to search

VectorCode

A code repository indexing tool to supercharge your LLM experience.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/davidyz--vectorcode/badge.svg)](/listings/davidyz--vectorcode)

HTML

<a href="/listings/davidyz--vectorcode"><img src="/api/listings/davidyz--vectorcode/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 120 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # VectorCode
  2. [![codecov](https://codecov.io/github/Davidyz/VectorCode/branch/main/graph/badge.svg?token=TWXLOUGG66)](https://codecov.io/github/Davidyz/VectorCode)
  3. [![Test and Coverage](https://github.com/Davidyz/VectorCode/actions/workflows/test_and_cov.yml/badge.svg)](https://github.com/Davidyz/VectorCode/actions/workflows/test_and_cov.yml)
  4. [![pypi](https://img.shields.io/pypi/v/vectorcode.svg)](https://pypi.org/project/vectorcode/)
  5. VectorCode is a code repository indexing tool. It helps you build better prompt
  6. for your coding LLMs by indexing and providing information about the code
  7. repository you're working on. This repository also contains the corresponding
  8. neovim plugin that provides a set of APIs for you to build or enhance AI plugins,
  9. and integrations for some of the popular plugins.
  10. > [!NOTE]
  11. > This project is in beta quality and is undergoing rapid iterations.
  12. > I know there are plenty of rooms for improvements, and any help is welcomed.
  13. <!-- mtoc-start -->
  14. * [Why VectorCode?](#why-vectorcode)
  15. * [Documentation](#documentation)
  16. * [About Versioning](#about-versioning)
  17. * [TODOs](#todos)
  18. * [Credit](#credit)
  19. * [Special Thanks](#special-thanks)
  20. * [Star History](#star-history)
  21. <!-- mtoc-end -->
  22. ## Why VectorCode?
  23. LLMs usually have very limited understanding about close-source projects, projects
  24. that are not well-known, and cutting edge developments that have not made it into
  25. releases. Their capabilities on these projects are quite limited. With
  26. VectorCode, you can easily (and programmatically) inject task-relevant context
  27. from the project into the prompt. This significantly improves the quality of the
  28. model output and reduce hallucination.
  29. [![asciicast](https://asciinema.org/a/8WP8QJHNAR9lEllZSSx3poLPD.svg)](https://asciinema.org/a/8WP8QJHNAR9lEllZSSx3poLPD?t=3)
  30. ## Documentation
  31. > [!NOTE]
  32. > The documentation on the `main` branch reflects the code on the latest commit.
  33. > To check for the documentation for the version you're using, you can [check out
  34. > the corresponding tags](https://github.com/Davidyz/VectorCode/tags).
  35. - For the setup and usage of the command-line tool, see [the CLI documentation](./docs/cli.md);
  36. - For neovim users, after you've gone through the CLI documentation, please refer to
  37. [the neovim plugin documentation](./docs/neovim/README.md) (and optionally the [lua API reference](./docs/neovim/api_references.md))
  38. for further instructions.
  39. - Additional resources:
  40. - the [wiki](https://github.com/Davidyz/VectorCode/wiki) for extra tricks and
  41. tips that will help you get the most out of VectorCode;
  42. - the [discussions](https://github.com/Davidyz/VectorCode/discussions) where
  43. you can ask general questions and share your cool usages about VectorCode.
  44. - If you're feeling adanvturous, feel free to check out
  45. [the pull requests](https://github.com/Davidyz/VectorCode/pulls) for
  46. WIP features.
  47. If you're trying to contribute to this project, take a look at [the contribution
  48. guide](./docs/CONTRIBUTING.md), which contains information about some basic
  49. guidelines that you should follow and tips that you may find helpful.
  50. ### About Versioning
  51. This project follows an adapted semantic versioning:
  52. - Until 1.0.0 is released, the _major version number_ stays 0 which indicates that
  53. this project is still in early stage, and features/interfaces may change from
  54. time to time;
  55. - The _minor version number_ indicates __breaking changes__. When I decide to remove a
  56. feature/config option, the actual removal will happen when I bump the minor
  57. version number. Therefore, if you want to avoid breaking a working setup, you
  58. may choose to use a version constraint like `"vectorcode<0.7.0"`;
  59. - The _patch version number_ indicates __non-breaking changes__. This can include new
  60. features and bug fixes. When I decide to deprecate things, I will make a new
  61. release with bumped patch version. Until the minor version number is bumped,
  62. the deprecated feature will still work but you'll see a warning. It's
  63. recommended to update your setup to adapt the new features.
  64. ## TODOs
  65. - [x] query by ~file path~ excluded paths;
  66. - [x] chunking support;
  67. - [x] add metadata for files;
  68. - [x] chunk-size configuration;
  69. - [x] smarter chunking (semantics/syntax based), implemented with
  70. [py-tree-sitter](https://github.com/tree-sitter/py-tree-sitter) and
  71. [tree-sitter-language-pack](https://github.com/Goldziher/tree-sitter-language-pack);
  72. - [x] configurable document selection from query results.
  73. - [x] ~NeoVim Lua API with cache to skip the retrieval when a project has not
  74. been indexed~ Returns empty array instead;
  75. - [x] job pool for async caching;
  76. - [x] [persistent-client](https://docs.trychroma.com/docs/run-chroma/persistent-client);
  77. - [ ] proper [remote Chromadb](https://docs.trychroma.com/production/administration/auth) support (with authentication, etc.);
  78. - [x] respect `.gitignore`;
  79. - [x] implement some sort of project-root anchors (such as `.git` or a custom
  80. `.vectorcode.json`) that enhances automatic project-root detection.
  81. **Implemented project-level `.vectorcode/` and `.git` as root anchor**
  82. - [x] ability to view and delete files in a collection;
  83. - [x] joint search (kinda, using codecompanion.nvim/MCP);
  84. - [x] Nix support (unofficial packages [here](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=vectorcode));
  85. - [ ] Query rewriting (#124).
  86. ## Credit
  87. - [@milanglacier](https://github.com/milanglacier) (and [minuet-ai.nvim](https://github.com/milanglacier/minuet-ai.nvim)) for the support when this project was still in early stage;
  88. - [@olimorris](https://github.com/olimorris) for the help (personally and
  89. from [codecompanion.nvim](https://github.com/olimorris/codecompanion.nvim))
  90. when this project made initial attempts at tool-calling;
  91. - [@ravitemer](https://github.com/ravitemer) for the help to interface
  92. VectorCode with [MCP](https://modelcontextprotocol.io/introduction);
  93. - The nix community (especially [@sarahec](https://github.com/sarahec) and [@GaetanLepage](https://github.com/GaetanLepage))
  94. for maintaining the nix packages.
  95. ### Special Thanks
  96. [![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSource)
  97. ## Star History
  98. [![Star History Chart](https://api.star-history.com/svg?repos=Davidyz/VectorCode&type=Date)](https://www.star-history.com/#Davidyz/VectorCode&Date)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.