Files
dumpy/README.md
2026-01-24 19:10:04 -06:00

39 lines
1.1 KiB
Markdown

# Dumpy
A simple tool for dumping a directory in a way that an LLM can understand it for adding to the context of a conversation. By default it recursively dumps from the current directory into the clipboard.
# Installation
```
git clone https://git.danhenry.dev/daniel/dumpy.git
cd dumpy
uv tool install .
```
# Updating
```
git clone https://git.danhenry.dev/daniel/dumpy.git
cd dumpy
uv tool install .
```
# Uninstalling
```
uv tool uninstall dumpy
```
# Usage
```
usage: dumpy.py [-h] [--no-gitignore] [--include-git-dir] [--no-clipboard] [--no-stats]
Dumpy: A tool for providing a text representation of a project formatted in a way that LLMs will understand.
options:
-h, --help show this help message and exit
--no-gitignore Ignore the .gitignore file and include all files
--include-git-dir Include the .git directory in the output
--no-clipboard Skip putting content into the clipboard and ouput directly to the console
--no-stats Skip printing stats at the end of the output
```
# Notes
- Token estimation is really bad, it's just the number of total characters divided by 4