code-preloader/README.md

104 lines
3.3 KiB
Markdown
Raw Normal View History

2023-12-29 13:57:11 +00:00
# Code-Preloader for ChatGPT
2023-12-29 13:13:20 +00:00
2023-12-29 14:05:51 +00:00
Code-Preloader is a specialized tool designed to streamline the process of
working with ChatGPT on coding projects. It preloads and concatenates files
from a specified directory, allowing for the seamless integration of customized
prompts. This tool is ideal for those who seek an alternative to tools like
GitHub Copilot, enabling a more efficient and tailored interaction with
ChatGPT.
2023-12-29 13:13:20 +00:00
2023-12-29 13:57:11 +00:00
## Features
2023-12-29 13:13:20 +00:00
2023-12-29 13:57:11 +00:00
* Preload and concatenate files from a given directory.
* Customizable header and footer prompts for ChatGPT.
* Simple command-line interface for easy operation.
2023-12-29 13:13:20 +00:00
2023-12-29 13:57:11 +00:00
## Limitations
2023-12-29 13:13:20 +00:00
2023-12-29 14:05:51 +00:00
**Note:** Note: This tool is optimized for smaller codebases. For larger
repositories, performance may not be optimal due to processing constraints and
the nature of interactions with ChatGPT.
2023-12-29 13:57:11 +00:00
## Installation
To get started with Code-Preloader, ensure that you have Crystal language installed on your system. Follow these steps to install:
```bash
git clone https://code.apps.glenux.net/glenux/chatgpt-preloader
2023-12-29 13:57:11 +00:00
cd code-preloader
shards install
shards build
2023-12-29 13:13:20 +00:00
```
## Usage
2023-12-29 13:57:11 +00:00
Run Code-Preloader with the following command-line options:
2023-12-29 13:13:20 +00:00
```
Usage: code-preloader [options] ROOT_DIR
-c CONFIG_FILE, --config=CONFIG_FILE
Load parameters from CONFIG_FILE
-i IGNORE_PATH, --ignore=IGNORE_PATH
Ignore file or directory
-o OUTPUT_FILE, --output=OUTPUT_FILE
Write output to OUTPUT_FILE
-H HEADER_PROMPT_FILE, --header-prompt=HEADER_PROMPT_FILE
Load header prompt from HEADER_PROMPT_FILE
-F FOOTER_PROMPT_FILE, --footer-prompt=FOOTER_PROMPT_FILE
Load footer prompt from FOOTER_PROMPT_FILE
-h, --help Show this help
2023-12-29 13:13:20 +00:00
```
2023-12-29 13:57:11 +00:00
### Examples
2023-12-29 14:05:51 +00:00
#### Basic Use Case
2023-12-29 13:57:11 +00:00
To preload all files in the `src` directory and output to `result.txt`, while
ignoring the `git` the `bin` directory, and the result file itself:
```bash
./bin/code-preloader -o result.txt -i .git -i result.txt -i bin/ src
```
2023-12-29 14:05:51 +00:00
#### Advanced Use Case
2023-12-29 13:57:11 +00:00
To preload all files in the `src` directory and output to clipboard, prepending
and appending prompts, while ignoring the `git` the `bin` directory, and the
result file itself:
```bash
./bin/code-preloader \
-o result.txt \
-i .git -i bin/ -i result.txt -i prompts \
--header-prompt prompts/header-context.txt \
--footer-prompt prompts/footer-write-readme.txt \
src \
| xclip -selection clipboard -i
```
## Contributing
Contributions are what make the open-source community such an amazing place to
learn, inspire, and create. Any contributions you make are **greatly
appreciated**.
## Troubleshooting and Support
If you encounter any issues or need support, please open an issue in the
project's GitHub issue tracker. We strive to be responsive and helpful.
## License
Distributed under the LGPL-3.0-or-later License. See `LICENSE` file for more
information.
## Acknowledgments
2023-12-29 14:05:51 +00:00
* A special thanks to all contributors and users of this project for their valuable feedback and support.
* Inspired by the community's need for efficient code preparation tools in the context of AI-assisted programming.
## Related projects
* [mpoon/gpt-repository-loader](https://github.com/mpoon/gpt-repository-loader)
2023-12-29 13:57:11 +00:00