.. vim: set fileencoding=utf-8:
.. -*- coding: utf-8 -*-
.. +--------------------------------------------------------------------------+
   |                                                                          |
   | Licensed under the Apache License, Version 2.0 (the "License");          |
   | you may not use this file except in compliance with the License.         |
   | You may obtain a copy of the License at                                  |
   |                                                                          |
   |     http://www.apache.org/licenses/LICENSE-2.0                           |
   |                                                                          |
   | Unless required by applicable law or agreed to in writing, software      |
   | distributed under the License is distributed on an "AS IS" BASIS,        |
   | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
   | See the License for the specific language governing permissions and      |
   | limitations under the License.                                           |
   |                                                                          |
   +--------------------------------------------------------------------------+

*******************************************************************************
                                   mimeogram
*******************************************************************************

.. image:: https://img.shields.io/pypi/v/mimeogram
   :alt: Package Version
   :target: https://pypi.org/project/mimeogram/

.. image:: https://img.shields.io/pypi/status/mimeogram
   :alt: PyPI - Status
   :target: https://pypi.org/project/mimeogram/

.. image:: https://github.com/emcd/python-mimeogram/actions/workflows/tester.yaml/badge.svg?branch=master&event=push
   :alt: Tests Status
   :target: https://github.com/emcd/python-mimeogram/actions/workflows/tester.yaml

.. image:: https://emcd.github.io/python-mimeogram/coverage.svg
   :alt: Code Coverage Percentage
   :target: https://github.com/emcd/python-mimeogram/actions/workflows/tester.yaml

.. image:: https://img.shields.io/github/license/emcd/python-mimeogram
   :alt: Project License
   :target: https://github.com/emcd/python-mimeogram/blob/master/LICENSE.txt

.. image:: https://img.shields.io/pypi/pyversions/mimeogram
   :alt: Python Versions
   :target: https://pypi.org/project/mimeogram/

.. image:: https://raw.githubusercontent.com/emcd/python-mimeogram/master/data/pictures/logo.svg
   :alt: Mimeogram Logo
   :width: 800
   :align: center


📨 A command-line tool for **exchanging collections of files with Large
Language Models** - bundle multiple files into a single clipboard-ready
document while preserving directory structure and metadata... good for code
reviews, project sharing, and LLM interactions.


Key Features ⭐
===============================================================================

* 🔄 **Interactive Reviews**: Review and apply LLM-proposed changes one by one.
* 📋 **Clipboard Integration**: Seamless copying and pasting by default.
* 🗂️ **Directory Structure**: Preserves hierarchical file organization.
* 🛡️ **Path Protection**: Safeguards against dangerous modifications.


Installation 📦
===============================================================================

Method: Download Standalone Executable
-------------------------------------------------------------------------------

Download the latest standalone executable for your platform from `GitHub
Releases <https://github.com/emcd/python-mimeogram/releases>`_. These
executables have no dependencies and work out of the box.

Method: Install Executable Script
-------------------------------------------------------------------------------

Install via the `uv <https://github.com/astral-sh/uv/blob/main/README.md>`_
``tool`` command:

::

    uv tool install mimeogram

or, run directly with `uvx
<https://github.com/astral-sh/uv/blob/main/README.md>`_:

::

    uvx mimeogram

Or, install via `pipx <https://pipx.pypa.io/stable/installation/>`_:

::

    pipx install mimeogram

Method: Install Python Package
-------------------------------------------------------------------------------

Install via `uv <https://github.com/astral-sh/uv/blob/main/README.md>`_ ``pip``
command:

::

    uv pip install mimeogram

Or, install via ``pip``:

::

    pip install mimeogram


Examples 💡
===============================================================================

Below are some simple examples. Please see the `examples documentation
<https://github.com/emcd/python-mimeogram/blob/master/documentation/examples/cli.rst>`_
for more detailed usage patterns.

::

    usage: mimeogram [-h] [OPTIONS] {create,apply,provide-prompt,version}

    Mimeogram: hierarchical data exchange between humans and LLMs.

    ╭─ options ────────────────────────────────────────────────────────────────────╮
    │ -h, --help              show this help message and exit                      │
    │ --configfile {None}|STR                                                      │
    │                         (default: None)                                      │
    ╰──────────────────────────────────────────────────────────────────────────────╯
    ╭─ subcommands ────────────────────────────────────────────────────────────────╮
    │ {create,apply,provide-prompt,version}                                        │
    │     create              Creates mimeogram from filesystem locations or URLs. │
    │     apply               Applies mimeogram to filesystem locations.           │
    │     provide-prompt      Provides LLM prompt text for mimeogram format.       │
    │     version             Prints version information.                          │
    ╰──────────────────────────────────────────────────────────────────────────────╯

Working with Simple LLM Interfaces
-------------------------------------------------------------------------------

Use with browser chat interfaces and API workbenches when you want explicit,
portable control over exactly which files are shared with a model. This is
useful for interfaces with limited repository tooling and for workflows where
uploaded files may have favorable pricing (for example, some project-oriented
plans in provider-hosted web interfaces).

* Bundle files with mimeogram format instructions into clipboard.

  .. code-block:: bash

      mimeogram create src/*.py tests/*.py --prepend-prompt

* Paste instructions and mimeogram into prompt text area in browser.

* Interact with LLM until you are ready to apply results.

* Request mimeogram from LLM and copy it from browser to clipboard.

  * `Example: Claude Artifact <https://claude.site/artifacts/5ca7851f-6b63-4d1d-87ff-cd418f3cab0f>`_

* Apply mimeogram parts from clipboard. (On a terminal, this will be
  interactive by default.)

  .. code-block:: bash

      mimeogram apply

Note that, if you do not want the LLM to return mimeograms to you, most of the
current generation of LLMs are smart enough to understand the format without
instructions. Thus, you can save tokens by not explicitly providing mimeogram
instructions.


Working with LLM Project Interfaces
-------------------------------------------------------------------------------

Many LLM service providers now offer project-style workspaces that persist
instructions and uploaded context across chats. When available, this pairs well
with mimeogram by reducing prompt overhead while preserving structured file
exchange.

In these cases, you can take advantage of the project instructions so that you
do not need to include mimeogram instructions with each new chat:

* Copy mimeogram format instructions into clipboard.

  .. code-block:: bash

      mimeogram provide-prompt

* Paste mimeogram prompt into project instructions and save the update. Any new
  chats will be able to reuse the project instructions hereafter.

* Simply create mimeograms for new chats without prepending instructions.

  .. code-block:: bash

      mimeogram create src/*.py tests/*.py

* Same workflow as chats without project support at this point: interact with
  LLM, request mimeogram (as necessary), apply mimeogram (as necessary).


Remote URLs
-------------------------------------------------------------------------------

You can also create mimeograms from remote URLs:

.. code-block:: bash

     mimeogram create https://raw.githubusercontent.com/BurntSushi/aho-corasick/refs/heads/master/src/dfa.rs

Both local and remote files may be bundled together in the same mimeogram.

However, there is no ability to apply a mimeogram to remote URLs.


Interactive Review
-------------------------------------------------------------------------------

During application of a mimeogram, you will be, by default, presented with the
chance to review each part to apply. For each part, you will see a menu like
this:

.. code-block:: text

    src/example.py [2.5K]
    Action? (a)pply, (d)iff, (e)dit, (i)gnore, (s)elect hunks, (v)iew >

Choosing ``a`` to select the ``apply`` action will cause the part to be queued
for application once the reivew of all parts is complete. All queued parts are
applied simultaneously to prevent thrash in IDEs and language servers as
interdependent files are reevaluated.


Filesystem Protection
-------------------------------------------------------------------------------

If an LLM proposes the alteration of a sensitive file, such as one which may
contain credentials or affect the operating system, then the program makes an
attempt to flag this:

.. code-block:: text

    ~/.config/sensitive.conf [1.2K] [PROTECTED]
    Action? (d)iff, (i)gnore, (p)ermit changes, (v)iew >

If, upon review of the proposed changes, you believe that they are safe, then
you can choose ``p`` to permit them, followed by ``a`` to apply them.

We take AI safety seriously. Please review all LLM-generated content, whether
it is flagged for a sensitive destination or not.


Configuration 🔧
===============================================================================

Default Location
-------------------------------------------------------------------------------

Mimeogram creates a configuration file on first run. You can find it at:

* Linux: ``~/.config/mimeogram/general.toml``
* macOS: ``~/Library/Application Support/mimeogram/general.toml``
* Windows: ``%LOCALAPPDATA%\\mimeogram\\general.toml``

Default Settings
-------------------------------------------------------------------------------

.. code-block:: toml

    [apply]
    from-clipboard = true    # Read from clipboard by default

    [create]
    to-clipboard = true      # Copy to clipboard by default

    [prompt]
    to-clipboard = true      # Copy prompts to clipboard

    [acquire-parts]
    fail-on-invalid = false  # Skip invalid files
    recurse-directories = false

    [update-parts]
    disable-protections = false


Motivation 🎯
===============================================================================

Why Mimeogram in an Agentic World 💡
-------------------------------------------------------------------------------
* Portable, provider-agnostic format for sharing and applying multi-file
  changes.
* Works in web interfaces and chat surfaces that do not expose local
  filesystem tools.
* Useful when you want explicit, auditable context selection instead of
  full-repository agent access.
* Supports batch exchange workflows, including scenarios where uploaded files
  can be cheaper than repeated API context transmission.

Technical Benefits ✅
-------------------------------------------------------------------------------
* Preserves hierarchical directory structure.
* Version control friendly. (I.e., honors Git ignore files.)
* Supports async/batch workflows.

Platform Neutrality ☁️
-------------------------------------------------------------------------------
* IDE and platform agnostic.
* Works with and without provider-specific agent tooling.
* Useful with both project-enabled and non-project chat interfaces.

Limitations and Alternatives 🔀
===============================================================================

* Manual refresh of files needed (no automatic sync).
* Cannot retract stale content from conversation history in provider GUIs.
* For tight edit/test loops inside a local repository, agentic tools and
  coding IDEs may be faster.

Comparison of General Approaches ⚖️
-------------------------------------------------------------------------------

+-------------------------+------------+------------+-------------+--------------+
| Feature                 | Mimeograms | Projects   | Agentic     | Specialized  |
|                         |            | (Web) [1]_ | CLIs [2]_   | IDEs [3]_    |
+=========================+============+============+=============+==============+
| Primary Interaction     | Bundle/    | Chat +     | Local tools | IDE-native   |
| Model                   | apply      | uploads    | + chat      | assistant    |
+-------------------------+------------+------------+-------------+--------------+
| Directory Structure     | Yes        | No         | Yes         | Yes          |
+-------------------------+------------+------------+-------------+--------------+
| Version Control         | Yes        | No [4]_    | Yes         | Yes          |
+-------------------------+------------+------------+-------------+--------------+
| Platform Support        | Cross-     | Web        | Varies      | Varies       |
|                         | platform   |            |             |              |
+-------------------------+------------+------------+-------------+--------------+
| Local Repo Live Sync    | Manual     | No         | Yes         | Yes          |
+-------------------------+------------+------------+-------------+--------------+
| Provider Portability    | High       | Low        | Medium      | Low/Medium   |
+-------------------------+------------+------------+-------------+--------------+
| Setup Required          | Low        | None       | Medium      | Medium       |
+-------------------------+------------+------------+-------------+--------------+
| Cost Model              | Varies     | Usually    | Varies      | Usually      |
|                         |            | subscr.    |             | subscr.      |
+-------------------------+------------+------------+-------------+--------------+

.. [1] Provider-hosted project workspaces in web interfaces.
.. [2] `Aider <https://aider.chat/>`_, `Claude Code
   <https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview>`_,
   `Codex CLI <https://developers.openai.com/codex/cli/>`_, etc...
.. [3] `Cursor <https://cursor.com/en-US>`_, `Windsurf
   <https://windsurf.com/editor>`_, etc...
.. [4] Some hosted interfaces provide versioned artifacts or revision history
   (for example, Claude artifacts), but these are not integrated with
   traditional VCS workflows such as Git.

Notes:

- No single column is universally best.
- Mimeogram is designed to complement agentic tools, especially when you need
  explicit scope control or provider portability.


Comparison with Similar Tools ⚖️
-------------------------------------------------------------------------------

- `ai-digest <https://github.com/khromov/ai-digest>`_
- `dump_dir <https://github.com/fargusplumdoodle/dump_dir/>`_
- `Gitingest <https://github.com/coderamp-labs/gitingest>`_
- `Repomix <https://github.com/yamadashy/repomix>`_

Mimeogram is unique among file collection tools for LLMs in offering round-trip
support - the ability to not just collect files but also apply changes proposed
by LLMs.

`Full Comparison of Tools
<https://github.com/emcd/python-mimeogram/blob/master/documentation/comparisons.rst>`_

Features Matrix
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+--------------------+-----------+-----------+------------+-----------+
| Feature            | Mimeogram | Gitingest | Repomix    | dump_dir  |
+====================+===========+===========+============+===========+
| Round Trips        | ✓         |           |            |           |
+--------------------+-----------+-----------+------------+-----------+
| Clipboard Support  | ✓         |           | ✓          | ✓         |
+--------------------+-----------+-----------+------------+-----------+
| Remote URL Support | ✓         | ✓         | ✓          |           |
+--------------------+-----------+-----------+------------+-----------+
| Security Checks    | ✓         |           | ✓          |           |
+--------------------+-----------+-----------+------------+-----------+

Content Selection Approaches
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Tools in this space generally follow one of two approaches: filesystem-oriented
or repository-oriented.

Tools, like ``mimeogram``, ``dump_dir``, and ``ai-digest``, are oriented around
files and directories. You start with nothing and select what is needed. This
approach offers more precise control over context window usage and is better
suited for targeted analysis or specific features.

Tools, like ``gitingest`` and ``repomix``, are oriented around code
repositories. You start with an entire repository and then filter out unneeded
files and directories. This approach is better for full project comprehension
but requires careful configuration to avoid exceeding LLM context window
limits.


Contribution 🤝
===============================================================================

Contribution to this project is welcome! However, it must follow the `code of
conduct
<https://emcd.github.io/python-project-common/stable/sphinx-html/common/conduct.html>`_
for the project.

Please file bug reports and feature requests in the `issue tracker
<https://github.com/emcd/python-mimeogram/issues>`_ or submit `pull
requests <https://github.com/emcd/python-mimeogram/pulls>`_ to
improve the source code or documentation.

For development guidance and standards, please see the `development guide
<https://emcd.github.io/python-mimeogram/stable/sphinx-html/contribution.html#development>`_.


About the Name 📝
===============================================================================

The name "mimeogram" draws from multiple sources:

* 📜 From Ancient Greek roots:
    * μῖμος (*mîmos*, "mimic") + -γραμμα (*-gramma*, "written character, that
      which is drawn")
    * Like *mimeograph* but emphasizing textual rather than pictorial content.

* 📨 From **MIME** (Multipurpose Internet Mail Extensions):
    * Follows naming patterns from the Golden Age of Branding: Ford
      Cruise-o-matic, Ronco Veg-O-Matic, etc....
    * Reflects the MIME-inspired bundle format.

* 📬 Echoes *telegram*:
    * Emphasizes message transmission.
    * Suggests structured communication.

Note: Despite similar etymology, this project is distinct from the PyPI package
*mimeograph*, which serves different purposes.

Pronunciation? The one similar to *mimeograph* seems to roll off the tongue
more smoothly, though it is one more syllable than "mime-o-gram". Preferred
IPA: /ˈmɪm.i.ˌoʊ.ɡræm/.


Additional Indicia
===============================================================================

.. image:: https://img.shields.io/github/last-commit/emcd/python-mimeogram
   :alt: GitHub last commit
   :target: https://github.com/emcd/python-mimeogram

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json
   :alt: Copier
   :target: https://github.com/copier-org/copier

.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
   :alt: Hatch
   :target: https://github.com/pypa/hatch

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
   :alt: pre-commit
   :target: https://github.com/pre-commit/pre-commit

.. image:: https://microsoft.github.io/pyright/img/pyright_badge.svg
   :alt: Pyright
   :target: https://microsoft.github.io/pyright

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :alt: Ruff
   :target: https://github.com/astral-sh/ruff

.. image:: https://img.shields.io/badge/hypothesis-tested-brightgreen.svg
   :alt: Hypothesis
   :target: https://hypothesis.readthedocs.io/en/latest/

.. image:: https://img.shields.io/pypi/implementation/mimeogram
   :alt: PyPI - Implementation
   :target: https://pypi.org/project/mimeogram/

.. image:: https://img.shields.io/pypi/wheel/mimeogram
   :alt: PyPI - Wheel
   :target: https://pypi.org/project/mimeogram/


Other Projects by This Author 🌟
===============================================================================


* `python-absence <https://github.com/emcd/python-absence>`_ (`absence <https://pypi.org/project/absence/>`_ on PyPI)

  🕳️ A Python library package which provides a **sentinel for absent values** - a falsey, immutable singleton that represents the absence of a value in contexts where ``None`` or ``False`` may be valid values.
* `python-accretive <https://github.com/emcd/python-accretive>`_ (`accretive <https://pypi.org/project/accretive/>`_ on PyPI)

  🌌 A Python library package which provides **accretive data structures** - collections which can grow but never shrink.
* `python-classcore <https://github.com/emcd/python-classcore>`_ (`classcore <https://pypi.org/project/classcore/>`_ on PyPI)

  🏭 A Python library package which provides **foundational class factories and decorators** for providing classes with attributes immutability and concealment and other custom behaviors.
* `python-detextive <https://github.com/emcd/python-detextive>`_ (`detextive <https://pypi.org/project/detextive/>`_ on PyPI)

  🕵️ A Python library which provides consolidated text detection capabilities for reliable content analysis. Offers MIME type detection, character set detection, and line separator processing.
* `python-dynadoc <https://github.com/emcd/python-dynadoc>`_ (`dynadoc <https://pypi.org/project/dynadoc/>`_ on PyPI)

  📝 A Python library package which bridges the gap between **rich annotations** and **automatic documentation generation** with configurable renderers and support for reusable fragments.
* `python-falsifier <https://github.com/emcd/python-falsifier>`_ (`falsifier <https://pypi.org/project/falsifier/>`_ on PyPI)

  🎭 A very simple Python library package which provides a **base class for falsey objects** - objects that evaluate to ``False`` in boolean contexts.
* `python-frigid <https://github.com/emcd/python-frigid>`_ (`frigid <https://pypi.org/project/frigid/>`_ on PyPI)

  🔒 A Python library package which provides **immutable data structures** - collections which cannot be modified after creation.
* `python-icecream-truck <https://github.com/emcd/python-icecream-truck>`_ (`icecream-truck <https://pypi.org/project/icecream-truck/>`_ on PyPI)

  🍦 **Flavorful Debugging** - A Python library which enhances the powerful and well-known ``icecream`` package with flavored traces, configuration hierarchies, customized outputs, ready-made recipes, and more.
* `python-librovore <https://github.com/emcd/python-librovore>`_ (`librovore <https://pypi.org/project/librovore/>`_ on PyPI) 

  🐲 **Documentation Search Engine** - An intelligent documentation search and extraction tool that provides both a command-line interface for humans and an MCP (Model Context Protocol) server for AI agents. Search across Sphinx and MkDocs sites with fuzzy matching, extract clean markdown content, and integrate seamlessly with AI development workflows.
