Metadata-Version: 2.2
Name: git2string
Version: 0.1.2
Summary: A tool to turn a Git repository into an LLM-friendly prompt
Home-page: https://github.com/hathibelagal-dev/git2string
Author: Ashraff Hathibelagal
Project-URL: Source, https://github.com/hathibelagal-dev/git2string
Project-URL: Tracker, https://github.com/hathibelagal-dev/git2string/issues
Keywords: ai language-models devtools gpt-4 openai llama mistral gemini chatbot
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tqdm
Requires-Dist: tiktoken
Requires-Dist: rich
Requires-Dist: pathspec
Requires-Dist: gitpython
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# git2string
git2string is a powerful tool that can quickly convert an entire Git repository to a prompt that can be fed to any large language model (LLM).

It will automatically ignore all binary files. Additionally, it will respect your **.gitignore**.

## Usage

```
git2string <url of repository>
```

For example:

```
git2string https://github.com/mozilla/experimenter
```

If you have cloned your desired repository already, you can just specify its path.

```
git2string <repo root directory>
```

By default, the prompt will be generated in a file called **llm_prompt.txt**.

You can specify a different filename as follows:

```
git2string <repo root directory> --output-file <filename>
```

## Additional Features

- Can count tokens for most OpenAI models
