Concatenate a directory full of files into a single prompt for use with LLMs
Project description
files-to-prompt
Concatenate a directory full of files into a single prompt for use with LLMs
Installation
Install this tool using pip
:
pip install files-to-prompt
Usage
To use files-to-prompt
, provide the path to one or more files or directories you want to process:
files-to-prompt path/to/file_or_directory [path/to/another/file_or_directory ...]
This will output the contents of every file, with each file preceded by its relative path and separated by ---
.
Options
-
--include-hidden
: Include files and folders starting with.
(hidden files and directories).files-to-prompt path/to/directory --include-hidden
-
--ignore-gitignore
: Ignore.gitignore
files and include all files.files-to-prompt path/to/directory --ignore-gitignore
-
--ignore <pattern>
: Specify one or more patterns to ignore. Can be used multiple times.files-to-prompt path/to/directory --ignore "*.log" --ignore "temp*"
Example
Suppose you have a directory structure like this:
my_directory/
├── file1.txt
├── file2.txt
├── .hidden_file.txt
├── temp.log
└── subdirectory/
└── file3.txt
Running files-to-prompt my_directory
will output:
my_directory/file1.txt
---
Contents of file1.txt
---
my_directory/file2.txt
---
Contents of file2.txt
---
my_directory/subdirectory/file3.txt
---
Contents of file3.txt
---
If you run files-to-prompt my_directory --include-hidden
, the output will also include .hidden_file.txt
:
my_directory/.hidden_file.txt
---
Contents of .hidden_file.txt
---
...
If you run files-to-prompt my_directory --ignore "*.log"
, the output will exclude temp.log
:
my_directory/file1.txt
---
Contents of file1.txt
---
my_directory/file2.txt
---
Contents of file2.txt
---
my_directory/subdirectory/file3.txt
---
Contents of file3.txt
---
Development
To contribute to this tool, first checkout the code. Then create a new virtual environment:
cd files-to-prompt
python -m venv venv
source venv/bin/activate
Now install the dependencies and test dependencies:
pip install -e '.[test]'
To run the tests:
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for files_to_prompt-0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7265dfbc8daf4080520d0ba7ba8273e6467818fd0a1d201362a72e2ecd4b01ca |
|
MD5 | 11c4898a2358b64ab1071dd443a5e4c4 |
|
BLAKE2b-256 | ea0b5f662376f8b213e8448276566d99356a8f19733955a65ebadbf3c86c0cdc |