Skip to content

Commit

Permalink
Updated usage
Browse files Browse the repository at this point in the history
  • Loading branch information
FilippoLeone committed Apr 16, 2024
1 parent 6df9ca7 commit 3a8876c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,22 @@ This allows you to modify the project and see changes without reinstalling the p

Run the script by navigating to the project directory and using the following command:

`llm_code_prompter [target_folder] [file_pattern] [exclude_pattern] [platform]`
`llm_code_prompter [target_folder] [file_pattern] [exclude_pattern] [platform] --verbose`

Where:

[target_folder] is the path to the directory containing the files you want to include in your prompt.
[file_pattern] is the pattern to match the files you want to include (default is "*.py").
[exclude_pattern] is a comma-separated list of file paths or patterns to exclude (default is empty).
[platform] is the target platform for the clipboard operation (default is determined automatically).
--verbose is to print out the processed output prompt

Example usage:

llm_code_prompter /path/to/directory
llm_code_prompter /path/to/directory "*.py"
llm_code_prompter /path/to/directory "*.py" "tests/,__pycache__/"
llm_code_prompter /path/to/directory "*.py" "tests/,__pycache__/" win32
llm_code_prompter /path/to/directory "*.py" "tests/,__pycache__/" win32 --verbose

The script will read the contents of the specified directory, including any optional files (like OBJECTIVE.md and PROMPT.md), and then concatenate the contents of all the matching Python files. The resulting text will be copied to the system clipboard, so you can paste it into your LLM prompt.

Expand Down

0 comments on commit 3a8876c

Please sign in to comment.