LLMDog 🐶

LLMDog is a command-line tool designed to help you prepare files for LLM consumption. With an interactive terminal UI built on Bubble Tea and styled with Lip Gloss, LLMDog lets you navigate your file system, select files and directories (with support for Gitignore rules and recursive selection), and generate a Markdown-formatted output of your directory structure and file contents. The final output is automatically copied to your clipboard, streamlining your workflow for LLM-based projects.

Inspiration: This project was inspired by llmcat.

Features

• Interactive TUI: Browse and navigate your files and directories with an intuitive interface.
• Recursive File & Directory Selection: Easily select whole directories while automatically handling nested files and skipping Gitignored paths.
• Gitignore Support: Automatically respects your .gitignore file to exclude irrelevant files.
• Markdown Output: Generates a well-formatted Markdown report, complete with a file tree and file contents.
• Clipboard Integration: The output is copied directly to your clipboard for quick sharing and use.
• Cross-Platform: Built with Go, LLMDog works on macOS, Linux, and Windows.

Installation

From Source

Ensure you have Go installed (version 1.16 or higher is recommended). Then, clone the repository and build the application:

git clone https://github.com/doganarif/LLMDog.git
cd LLMDog
go build -o LLMDog ./cmd/LLMDog

Homebrew (macOS)

For macOS users, you can install LLMDog using Homebrew with my custom tap:

1. Tap the repository:

   brew tap doganarif/LLMDog
   

2. Install LLMDog:

   brew install LLMDog
   

Usage

Run LLMDog from your terminal:

./LLMDog [options]

Command-Line Options

• -h, --help: Show the help message
• -v, --version: Display the application version

Interactive TUI Keys

• ↑/↓: Navigate through list items
• Space: Expand or collapse folders
• Tab: Select or unselect an item
• /: Filter items
• ctrl+/: Toggle the preview pane
• Enter: Confirm selection and generate the Markdown output (which is also copied to your clipboard)
• q: Quit the application

Contributing

Contributions are welcome! If you find bugs or have ideas for improvements, please open an issue or submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

Development

To run and develop LLMDog, ensure you have the latest version of Go installed. Clone the repository, make your changes, and submit pull requests. Your contributions help improve the tool for everyone.

Acknowledgements

• llmcat: For the initial inspiration behind this project
• Bubble Tea & Lip Gloss: For providing the powerful TUI libraries that make this project possible

License

This project is licensed under the MIT License. See the LICENSE file for details.