Fork from gpt-repository-loader

gpt-repository-loader with Can-Install

gpt-repository-loader is a command-line tool that converts the contents of a Git repository into a text format, preserving the structure of the files and file contents. The generated output can be interpreted by AI language models, allowing them to process the repository's contents for various tasks, such as code review or documentation generation.

Contributing

Some context around building this is located here. Appreciate any issues and pull requests in the spirit of having mostly GPT build out this tool. Using ChatGPT Plus is recommended for quick access to GPT-4.

Getting Started

To get started with gpt-repository-loader, follow these steps:

1. Ensure you have Python 3 installed on your system.

2. Install the package directly from the GitHub repository:

   pip install git+https://github.com/Hashory/gpt-repository-loader-can-install.git

3. Run gpt-repository-loader with the following command:

   gpt-repository-loader /path/to/git/repository [-p /path/to/preamble.txt] [-o /path/to/output_file.txt]

   Replace /path/to/git/repository with the path to the Git repository you want to process. Optionally, you can specify a preamble file with -p or an output file with -o. If not specified, the default output file will be named output.txt in the current directory.

4. The tool will generate an output.txt file containing the text representation of the repository. You can now use this file as input for AI language models or other text-based processing tasks.

Running Tests

To run the tests for gpt-repository-loader, follow these steps:

1. Ensure you have Python 3 installed on your system.

2. Clone the repository:

   git clone https://github.com/Hashory/gpt-repository-loader-can-install.git
   cd gpt-repository-loader-can-install

3. Run the tests with the following command:

   python -m unittest test_gpt_repository_loader.py

License

This project is licensed under the MIT License - see the LICENSE file for details.