From 3a8876c76ec4342ece2052974767e22104d387a3 Mon Sep 17 00:00:00 2001 From: Filippo Leone Date: Tue, 16 Apr 2024 19:57:16 +0200 Subject: [PATCH] Updated usage --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 75789da..16fe066 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ 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: @@ -40,13 +40,14 @@ Where: [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.