glenux/code-preloader
1
0
Fork 0
Code Issues 19 Pull requests Projects 1 Releases Packages Wiki Activity
🟠 | Preloads and concatenate files from a specified directory to build a prompt for your LLM
7 commits 3 branches 0 tags 596 KiB
Crystal 71.4%
Shell 25.9%
Jinja 1.7%
Makefile 0.7%
C 0.3%
Find a file
Glenn 7279e489da chore: fix project name
2023-12-29 16:01:22 +01:00
prompts Update 2023-12-29 14:57:11 +01:00
src refactor: move config out of cli 2023-12-29 15:53:54 +01:00
.gitignore Initial import 2023-12-29 14:13:20 +01:00
LICENSE doc: add LICENSE 2023-12-29 15:55:16 +01:00
Makefile Update 2023-12-29 14:57:11 +01:00
README.md doc: update README with latest usage & repo 2023-12-29 15:58:18 +01:00
shard.yml chore: fix project name 2023-12-29 16:01:22 +01:00

README.md

Code-Preloader for ChatGPT

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.

Features

  • Preload and concatenate files from a given directory.
  • Customizable header and footer prompts for ChatGPT.
  • Simple command-line interface for easy operation.

Limitations

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.

Installation

To get started with Code-Preloader, ensure that you have Crystal language installed on your system. Follow these steps to install:

git clone https://code.apps.glenux.net/glenux/chatgpt-preloader
cd code-preloader
shards install
shards build

Usage

Run Code-Preloader with the following command-line options:

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

Examples

Basic Use Case

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:

./bin/code-preloader -o result.txt -i .git -i result.txt -i bin/ src

Advanced Use Case

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:

./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

  • 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