gpt-code-search 0.0.3

gpt-code-search enables you to search your codebase with natural language.

gpt-code-search

gpt-code-search enables you to search your codebase with natural language using GPT-4.

Features

• 🧠 GPT-4: code search, retrieval, and answering all done with OpenAI and function calling.
• 🔐 Privacy-first: code snippets only leave your machine when you ask a question and the LLM requests the relevant code.
• 🔥 Works instantly: no pre-processing, chunking, or indexing, get started right away.
• 📦 File-system backed: works with any code on your machine.

Getting Started

Installation

pip install gpt-code-search

Usage

Ask a question about your codebase

gpt-code-search query ""

Select a model

gpt-code-search select-model

Defaults to gpt-3.5-turbo-16k. The selected model is stored in ~/$HOME/.gpt-code-search/config.toml.

Configuration

The tool will prompt you to configure the OPENAI_API_KEY, if you haven't already.

Problem

You want to leverage the power of GPT-4 to search your codebase, but you don't want to manually copy and paste code snippets into a prompt nor send your code to another third-party service.

This tool solves these problems by letting GPT-4 determine the most relevant code snippets within your codebase. This removes the need to copy and paste or send your code to another third-party. Also, it meets you where you already live, in your terminal, not a new UI or window.

Examples of the types of questions you might want to ask:

• 🐛 Help debugging errors and finding the relevant code and files
• 📝 Document large files or functionalities formatted as markdown
• 🛠️ Generate new code based on existing files and conventions
• 📨 Ask general questions about any part of the code

Privacy

Outside of the LLM, no data is sent or stored.

The only data sent to LLM is the question you ask and the code snippets that is requests related to your question. All code snippets are retrieved from your local machine.

Wolfia Codex

This tool is a simplified version of Wolfia Codex, a cloud tool that enables you to ask any question about open source and private code bases like Langchain, Vercel ai, or gpt-engineer.

If you're looking for a more powerful tool, or avoiding the setup, check out Wolfia Codex, search codebases, share your questions and answers, and more!

Development

The project uses poetry for dependency management and packaging. To get started, install poetry and run the following commands:

# Install dependencies
poetry install

Run the project

# Run the project
poetry run python core/main.py

Install pre-commit hooks

# Install pre-commit hooks
poetry run pre-commit install

Contact

If you need help or have any questions, please reach out to us at [e-mail].

License

Apache 2.0 © Wolfia