chewt/repo_prompt_context
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add README.md

Browse source
This commit is contained in:
Hayden Johnson 2024-07-28 18:34:31 -07:00
parent c34eb49184
commit 7fe82523b6
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# Project Title
This project contains two Bash scripts used to generate context files for prompting LLM's with repo-wide context.
## Scripts
### `naive-prompt.sh`
This script lists all files in the git repository, excluding `.gitignore` and `LICENSE` files. It prints each file's name followed by its contents, formatted as Markdown code blocks. The output provides a comprehensive list of files and their contents, suitable for use as as prepended context as a prompt to an llm to ask questions about a repo.
**NOTE** this puts the entire repository in context, so make sure the LLM you feed it into has enough of a context window to support it. That is the purpose of the script below.
### `repo-size.sh`
This script provides statistics about the size of the git repository, excluding `.gitignore` and `LICENSE` files. It calculates the number of words, bytes, and estimated tokens (based on dividing the word count by 4) in the repository.