# 🪄 promptify

_Gather your codebase into a single, LLM-ready prompt in seconds!_


**promptify** is a command-line tool that instantly collects any set of files from your project into a single, clearly structured prompt file—ready for Large Language Models (LLMs) like ChatGPT, Gemini, or Copilot.
It is distributed as the Python package **promptify-ai**.

With one command, you can include your entire codebase, or just selected files, with clear headers and zero manual copy-paste. Ideal for code reviews, AI-powered refactoring, or feeding full project context to your favorite AI coding assistant!



## Features

- **Combine your entire project or selected files** using flexible file patterns, with support for multiple patterns specified separately.
- **Easily exclude files or directories** from the output.
- **Clear file boundaries** thanks to auto-generated headers.
- **Optional project tree overview** for quick context of your directory structure.
- **Clipboard integration:** result is automatically copied for easy pasting.
- **Fast and lightweight**—works with projects of any size.


## Quick Start

```bash

# Collect files from 'myapp/', output to 'llm_context.txt', using custom patterns and excluding a folder
 promptify -s myapp -o llm_context.txt -p '*.md' '*.js' -e 'docs'
# Include files under 'app/src' and add a project tree from its parent directory
 promptify -s app/src -o prompt.llm -t app

# See all available options
 promptify -h
```


## How it Works

* Recursively scans the specified directory for files matching your patterns.
* Skips files or directories you choose to exclude.
* Concatenates each file’s content into a single prompt, optionally saved to a file, preceded by a project tree.
* Files are clearly marked:

  ```
  # === BEGIN FILE: path/to/your/file.ext ===
  ...file content...
  # === END FILE ===
  ```
* Automatically copies the result to your clipboard for easy pasting into LLM interfaces.



## Why Use promptify?

* **Save time:** No more copying files one by one for your AI prompts.
* **Boost LLM performance:** Provide your entire context at once.
* **Stay organized:** File headers make navigation easy for you and the LLM.
* **Stay focused:** Exclude unnecessary files and keep prompts concise.



## Installation

Install the package from PyPI:

```bash
pip install promptify-ai
```

After installation, run the CLI via the command:

```bash
promptify -h
```


## License

MIT License.
