Back to search
VectorCode
SkillGitHub
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
Markdown
[](/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)
- # VectorCode
- [](https://codecov.io/github/Davidyz/VectorCode)
- [](https://github.com/Davidyz/VectorCode/actions/workflows/test_and_cov.yml)
- [](https://pypi.org/project/vectorcode/)
- VectorCode is a code repository indexing tool. It helps you build better prompt
- for your coding LLMs by indexing and providing information about the code
- repository you're working on. This repository also contains the corresponding
- neovim plugin that provides a set of APIs for you to build or enhance AI plugins,
- and integrations for some of the popular plugins.
- > [!NOTE]
- > This project is in beta quality and is undergoing rapid iterations.
- > I know there are plenty of rooms for improvements, and any help is welcomed.
- <!-- mtoc-start -->
- * [Why VectorCode?](#why-vectorcode)
- * [Documentation](#documentation)
- * [About Versioning](#about-versioning)
- * [TODOs](#todos)
- * [Credit](#credit)
- * [Special Thanks](#special-thanks)
- * [Star History](#star-history)
- <!-- mtoc-end -->
- ## Why VectorCode?
- LLMs usually have very limited understanding about close-source projects, projects
- that are not well-known, and cutting edge developments that have not made it into
- releases. Their capabilities on these projects are quite limited. With
- VectorCode, you can easily (and programmatically) inject task-relevant context
- from the project into the prompt. This significantly improves the quality of the
- model output and reduce hallucination.
- [](https://asciinema.org/a/8WP8QJHNAR9lEllZSSx3poLPD?t=3)
- ## 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](https://github.com/Davidyz/VectorCode/tags).
- - For the setup and usage of the command-line tool, see [the CLI documentation](./docs/cli.md);
- - For neovim users, after you've gone through the CLI documentation, please refer to
- [the neovim plugin documentation](./docs/neovim/README.md) (and optionally the [lua API reference](./docs/neovim/api_references.md))
- for further instructions.
- - Additional resources:
- - the [wiki](https://github.com/Davidyz/VectorCode/wiki) for extra tricks and
- tips that will help you get the most out of VectorCode;
- - the [discussions](https://github.com/Davidyz/VectorCode/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](https://github.com/Davidyz/VectorCode/pulls) for
- WIP features.
- If you're trying to contribute to this project, take a look at [the contribution
- guide](./docs/CONTRIBUTING.md), 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](https://github.com/tree-sitter/py-tree-sitter) and
- [tree-sitter-language-pack](https://github.com/Goldziher/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](https://docs.trychroma.com/docs/run-chroma/persistent-client);
- - [ ] proper [remote Chromadb](https://docs.trychroma.com/production/administration/auth) 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](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=vectorcode));
- - [ ] Query rewriting (#124).
- ## Credit
- - [@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;
- - [@olimorris](https://github.com/olimorris) for the help (personally and
- from [codecompanion.nvim](https://github.com/olimorris/codecompanion.nvim))
- when this project made initial attempts at tool-calling;
- - [@ravitemer](https://github.com/ravitemer) for the help to interface
- VectorCode with [MCP](https://modelcontextprotocol.io/introduction);
- - The nix community (especially [@sarahec](https://github.com/sarahec) and [@GaetanLepage](https://github.com/GaetanLepage))
- for maintaining the nix packages.
- ### Special Thanks
- [](https://jb.gg/OpenSource)
- ## Star History
- [](https://www.star-history.com/#Davidyz/VectorCode&Date)
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.