repo2text

Overview

repo2text compiles the entire codebase from any GitHub repository into a single .txt file for use with ChatGPT.

How I personally use it: I host the project on a VPS and keep a bookmark for the download link of my current project's repository. Then, I drag the resulting .txt file into ChatGPT, Or add the different endpoints as actions in my custom GPT.

Endpoints

/repo

Description: Outputs textual content of a GitHub repository specified by the repoName query parameter into a downloadable text file.

Input:

• repoName (required) - Name of the GitHub repository.

Output:

• Text file containing repository content.

/file-history

Description: Attaches a last updated timestamp to each line of a file in a GitHub repository specified by repoName and filePath.

Input:

• repoName (required) - Name of the GitHub repository.
• filePath (required) - Path to the file in the repository.

Output:

• Text file with last updated timestamp attached to each line.

/latest-updates

Description: Fetches and displays the latest committed updates from the past month for a specified GitHub repository, subject to either a token limit of 8000 tokens or the end of the one-month period, whichever condition is met first.

Input:

• repoName (required) - Name of the GitHub repository.

Output:

• Text representation of the most recent pushed updates.

Features

• Filters out non-text files and certain directories (e.g., node_modules, .git).

Getting Started

Prerequisites

Ensure you have Node.js installed on your system. You can download it from Node.js official website.

Installation

1. Clone this repository:

   git clone https://github.com/aladynjr/repo2text.git
   

2. Navigate to the repository directory:

   cd repo2text
   

3. Install the necessary dependencies:

   npm install
   

Configuration

Create a .env file in the root directory and set the following variable only if you are working with private repositories:

GITHUB_TOKEN=your_github_access_token_here

Generate a personal access token by following these instructions.

Usage

Start the server:

node repo2text.js

To extract text from a repository, make a GET request to http://localhost:3000/repo?repoName=aladynjr/repo2txt. Replace aladynjr/repo2txt with the GitHub repository name you want to process.

The server will process the repository and prompt you to download the resulting text file.

Contribution

Contributions are welcome! Feel free to open an issue or submit a pull request.

License

This project is licensed under the ISC License.