codeqai 0.0.10

No project description provided

codeqai

Search your codebase semantically or chat with it from cli. Keep the vector database superfast up to date to the latest code changes. 100% local support without any dataleaks. Built with langchain, treesitter, sentence-transformers, instructor-embedding, faiss, lama.cpp, Ollama.

https://github.com/fynnfluegge/codeqai/assets/16321871/2fa92c9b-8010-4487-adb0-c39aa6a5e762

✨ Features

• 🔎  Semantic code search
• 💬  GPT-like chat with your codebase
• ⚙️  Synchronize vector store and latest code changes with ease
• 💻  100% local embeddings and llms
  • sentence-transformers, instructor-embeddings, llama.cpp, Ollama
• 🌐  OpenAI and Azure OpenAI support
• 🌳  Treesitter integration

[!NOTE]
There will be better results if the code is well documented. You might consider doc-comments-ai for code documentation generation.

🚀 Usage

Start semantic search:

codeqai search

Start chat dialog:

codeqai chat

Synchronize vector store with current git checkout:

codeqai sync

At first usage, the repository will be indexed with the configured embeddings model which might take a moment.

📋 Requirements

• Python >= 3.9

📦 Installation

Install and run in one step:

pipx run --spec codeqai codeqai configure

You can also install codeqai through PyPI with pip install codeqai. However, it is recommended to use pipx instead to benefit from isolated environments.

[!NOTE]
Some packages are not installed by default. At first usage it is asked to install faiss-cpu or faiss-gpu. Faiss-gpu is recommended if the hardware supports CUDA 7.5+. If local embeddings and llms are used it will be further asked to install sentence-transformers, instructor or llama.cpp.

🔧 Configuration

At first usage or by running

codeqai configure

the configuration process is initiated, where the embeddings and llms can be chosen.

[!IMPORTANT]
If you want to change the embeddings model in the configuration later, make sure to delete the old files from ~/.cache/codeqai. Afterwards the vector store files are created again with the recent configured embeddings model. This is neccessary since the similarity search does not work if the models differ.

🌐 Remote models

If remote models are used, the following environment variables are required. If the required environment variables are already set, they will be used, otherwise you will be prompted to enter them which are then stored in ~/.config/codeqai/.env.

OpenAI

export OPENAI_API_KEY = "your OpenAI api key"

Azure OpenAI

export OPENAI_API_TYPE = "azure"
export OPENAI_API_BASE = "https://<your-endpoint>.openai.azure.com/"
export OPENAI_API_KEY = "your Azure OpenAI api key"
export OPENAI_API_VERSION = "2023-05-15"

[!NOTE]
To change the environment variables later, update the ~/.config/codeqai/.env manually.

💡 How it works

The entire git repo is parsed with treesitter to extract all methods with documentations and saved to a local FAISS vector database with either sentence-transformers, instructor-embeddings or OpenAI's text-embedding-ada-002. The vector database is saved to a file on your system and will be loaded later again after further usage.
Afterwards it is possible to do semantic search on the codebase based on the embeddings model.
To chat with the codebase locally llama.cpp or Ollama is used by specifying the desired model. Using llama.cpp the specified model needs to be available on the system in advance. Using Ollama the Ollama container with the desired model needs to be running locally in advance on port 11434. Also OpenAI or Azure-OpenAI can be used for remote chat models.

📚 Supported Languages

• Python
• Typescript
• Javascript
• Java
• Rust
• Kotlin
• Go
• C++
• C
• C#

？FAQ

Where do I get models for llama.cpp?

Install the huggingface-cli and download your desired model from the model hub. For example

huggingface-cli download TheBloke/CodeLlama-13B-Python-GGUF codellama-13b-python.Q5_K_M.gguf

will download the codellama-13b-python.Q5_K_M model. After the download has finished the absolute path of the model .gguf file is printed to the console.

[!IMPORTANT]
llama.cpp compatible models must be in the .gguf format.

✨ Contributing

If you are missing a feature or facing a bug don't hesitate to open an issue or raise a PR. Any kind of contribution is highly appreciated!