Welcome to promptprep's documentation!
====================================

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: License: MIT

.. image:: https://img.shields.io/badge/python-3.10+-blue.svg
   :target: https://www.python.org/downloads/
   :alt: Python Version

**promptprep** is a powerful command-line tool for bundling code from multiple files into one well-organized output file. It creates a visual map of your project structure and brings together all your selected files, making it perfect for working with AI models, creating documentation snapshots, analyzing your project, and facilitating code reviews.

.. note::
   This documentation provides comprehensive information about promptprep's features, installation, usage, and API reference. For a quick overview, check out the :ref:`quickstart` section.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation
   quickstart
   usage

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   features
   command_reference
   output_formats
   custom_templates
   configuration
   examples

.. toctree::
   :maxdepth: 2
   :caption: Advanced Topics

   incremental_processing
   diff_generation
   token_counting
   interactive_mode
   tips_and_tricks

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/modules
   api/aggregator
   api/formatters
   api/cli
   api/config
   api/tui

.. toctree::
   :maxdepth: 1
   :caption: Development

   contributing
   changelog
   roadmap

.. toctree::
   :maxdepth: 1
   :caption: Project Info

   license
   about

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`