Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.58 KB

README.md

File metadata and controls

29 lines (19 loc) · 1.58 KB
Raw

CodeBaseBuddy

Welcome to CodeBaseBuddy! This tool helps you navigate and understand your codebase better. For a visual walkthrough, check out our Presentation and Loom video

DZONE article: link

Getting Started

Follow these steps to get CodeBaseBuddy up and running:

  1. Install the required packages: pip install -r requirements.txt
  2. Clone the GitHub repository of your choice. For example: git clone https://github.com/PromtEngineer/localGPT
  3. Set your OpenAI API key in your terminal and in the code: export OPENAI_API_KEY=<your key>
  4. Build the index with the following command: python build_embeddings.py <name> <path to local github branch>. For example: python build_embeddings.py localGPT /home/raghavan/localGPT/

Usage

Once you've set up CodeBaseBuddy, you can start querying for your tasks. Here's an example:

(base) raghavan@raghavan-Blade-18-RZ09-0484:~/CodeBaseBuddy$ python search.py "which files should i change and how should i add support to new LLM Falcon 80b" 5 localGPT

Sample screenshots

Screenshot from 2023-10-14 00-19-13

Screenshot from 2023-10-14 00-21-33 Remember LLMs hallucinate :-)