Metadata-Version: 2.1
Name: talk-codebase
Version: 0.1.23
Summary: talk-codebase is a powerful tool for querying and analyzing codebases.
Keywords: chatgpt,openai,cli
Author: Saryev Rustam
Author-email: rustam1997@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: faiss-cpu (>=1.7.4,<2.0.0)
Requires-Dist: fire (>=0.5.0,<0.6.0)
Requires-Dist: gitpython (>=3.1.31,<4.0.0)
Requires-Dist: gpt4all (>=0.2.3,<0.3.0)
Requires-Dist: halo (>=0.0.31,<0.0.32)
Requires-Dist: langchain (>=0.0.181,<0.0.182)
Requires-Dist: openai (>=0.27.7,<0.28.0)
Requires-Dist: questionary (>=1.10.0,<2.0.0)
Requires-Dist: sentence-transformers (>=2.2.2,<3.0.0)
Requires-Dist: tiktoken (>=0.4.0,<0.5.0)
Requires-Dist: urllib3 (==1.26.6)
Description-Content-Type: text/markdown

# talk-codebase: A Tool for Chatting with Your Codebase

[![Node.js Package](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml)

<p align="center">
  <img src="https://github.com/rsaryev/talk-codebase/assets/70219513/b5d338f9-14a5-417b-9690-83f5cd66facf" width="800" alt="chat">
</p>

## Description

Talk-codebase is a powerful tool that allows you to converse with your codebase. It uses LLMs to answer your queries.

You can use [GPT4All](https://github.com/nomic-ai/gpt4all) for offline code processing without sharing your code with
third parties. Alternatively, you can use OpenAI if privacy is not a concern for you. You can switch between these two
options quickly and easily.

## Installation

```bash
pip install talk-codebase
```

## Usage

Talk-codebase works only with files of popular programming languages and .txt files. All other files will be ignored.

```bash
# Start chatting with your codebase
talk-codebase chat <directory>

# Configure or edit configuration ~/.config.yaml
talk-codebase configure

# Help
talk-codebase --help
```

## Requirements

- Python 3.9
- OpenAI API key [api-keys](https://platform.openai.com/account/api-keys)
- If you want to use GPT4All, you need to download the
  model [ggml-gpt4all-j-v1.3-groovy.bin](https://gpt4all.io/models/ggml-gpt4all-j-v1.3-groovy.bin) and specify the path
  to it in the configuration.
