TODO: Add blog links

A powerful code search and query system that lets you explore codebases using natural language. Ask questions about your code and get contextual answers powered by LLMs. Supports Python, Rust, JavaScript and Java with a clean, minimal UI.

Note: New OpenAI/Anthropic accounts may experience token rate limits. Consider using an established account.

What is CodeQA?

CodeQA helps you understand codebases by:

• Extracting code structure and metadata using tree-sitter AST parsing
• Indexing the code chunks using OpenAI/Jina embeddings and storing them in LanceDB
• Enabling natural language searches across the codebase
• Providing context-aware answers with references
• Supporting interactive chat-based code exploration

Prerequisites

• Python 3.6 or higher
• Redis server running on localhost:6379

Setup

1. Clone the repository:

   git clone https://github.com/sankalp1999/code_qa.git

2. Navigate to the project directory:

   cd code_qa

3. Set up a Python virtual environment:

   python3 -m venv venv
   source venv/bin/activate

4. Install the required packages:

   pip install -r requirements.txt

5. Run the redis server

redis-server

Configuration

You only need to set the OpenAI API key. Jina API key is optional, if you want to use Jina embeddings instead of OpenAI.

Create a .env file and add the following:

OPENAI_API_KEY="your-openai-api-key"
JINA_API_KEY="your-jina-api-key"

Building the Codebase Index

To build the index for the codebase, run the following script:

chmod +x index_codebase.sh

./index_codebase.sh <absolute_path_to_codebase>

This will parse the codebase to get the code chunks, generate embeddings, references and store them in LanceDB.

Usage

To start the server

python app.py <folder_path>

For example, to analyze a JavaScript project located in /Users/sankalp/Documents/code2prompt/twitter-circle, run:

python app.py /Users/sankalp/Documents/code2prompt/twitter-circle

Once the server is running, open a web browser and navigate to http://localhost:5001 to access the code search and query interface.

Technologies Used

• Flask: server and UI
• Treesitter: parsing methods, classes, constructor declarations in a language agnostic way using the abstract syntax tree
• LanceDB: vector db for storing and searching code embeddings
• Redis: in-memory data store for caching and session management
• OpenAI, Jina for chat functionalities and colbert-small-v1 for reranker

License

This project is licensed under the MIT License.