repcon
repcon is a Rust-based CLI tool that efficiently condenses the entire set of files in a repository into a maximum of 20 text documents. This tool is particularly useful for developers who want to bundle their repository's files for simplified sharing and review, especially when dealing with platforms that limit the number of uploadable files.
Background
repcon was developed to facilitate the creation of uploadable files for OpenAI's Assistants API Retrieval feature. With the API's limitation of handling a maximum of 20 files, repcon aims to efficiently condense larger repositories into a more manageable format. This tool is particularly useful for complex systems where the number of files can exceed the API's limit, thus simplifying the process of bundling repository files for use with OpenAI's API.
Please note that repcon is an independent project and is not officially associated with OpenAI.
Features
- Selective Inclusion: Automatically excludes files listed in
.gitignore, ensuring only the necessary files are included. - Custom Ignore Rules: Users can specify additional patterns to ignore files or directories, providing more control over the included content.
- Text Document Formatting: Each file's content is enclosed within a clear start and end comment, accompanied by a header indicating the file's path for easy identification.
Installation
To install repcon, use the following cargo command:
Make sure you have Rust and Cargo installed on your system. For more information on installing Rust, visit the official Rust installation guide.
Usage
After installing repcon with cargo install repcon, navigate to your repository's root directory and run the following command:
This will process all files within the repository, excluding any matches found in .gitignore, the node_modules directory, and all .log files.
Output Example
The generated text documents will have sections for each file, formatted like this:
# repcon_file_name: xxxxx
# repcon_page_number: 1
// START OF CODE BLOCK: xxxxx
fn main() {
// Example code here
}
// END OF CODE BLOCK: xxxxx
Files will be named according to the format specified by the user, or default to {output_file_name}_{file_no}.txt, where file_no is a sequence number.
Custom Ignore Rules
By creating a .repconignore file in your repository's root directory, you can define additional ignore patterns that are specific to repcon. The syntax is similar to .gitignore, with these patterns being exclusively used by repcon to filter out files or directories when generating the text documents.
Example of a .repconignore file:
# This is a comment
# Ignore all .log files
*.log
# Ignore specific directory
node_modules/
Contributing
Feel free to dive in! Open an issue or submit PRs. For major changes, please open an issue first to discuss what you would like to change.