https://github.com/emcd/python-mimeogram
Exchange collections of files with Large Language Models.
https://github.com/emcd/python-mimeogram
ai anthropic chatgpt claude code deepseek gemini grok ingestion llm openai
Last synced: 7 months ago
JSON representation
Exchange collections of files with Large Language Models.
- Host: GitHub
- URL: https://github.com/emcd/python-mimeogram
- Owner: emcd
- License: apache-2.0
- Created: 2025-02-15T02:24:07.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-03-02T01:12:07.000Z (7 months ago)
- Last Synced: 2025-03-02T01:25:56.397Z (7 months ago)
- Topics: ai, anthropic, chatgpt, claude, code, deepseek, gemini, grok, ingestion, llm, openai
- Language: Python
- Homepage: https://emcd.github.io/python-mimeogram/
- Size: 461 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: changelog.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
.. 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 📦
===============================================================================
Standalone Executable (Recommended)
-------------------------------------------------------------------------------
Download the latest standalone executable for your platform from `GitHub
Releases `_. These
executables have no dependencies and work out of the box.
Python Package
-------------------------------------------------------------------------------
Executables Environment Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install with `pipx `_:
::
pipx install mimeogram
(Pipx is preferred because it helps ensure that you have access to the
``mimeogram`` executable througout your system rather than in any specific
virtual environment.)
Package Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install with `uv `_:
::
uv pip install mimeogram
Or, install with ``pip``:
::
pip install mimeogram
Examples 💡
===============================================================================
Below are some simple examples. Please see the `examples documentation
`_
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 API workbenches and with LLM GUIs which do not support persistent
user-customized instructions (e.g., `DeepSeek `_,
`Google Gemini `_, `Grok `_):
* 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 `_
(may need to remix to see it because of Claude.ai display bug)
* 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
-------------------------------------------------------------------------------
Some LLM service providers have the concept of projects. These allow you to
organize chats and persist a set of instructions across chats. Projects might
only be available for certain models. Examples of LLM service providers, which
support projects with some of their models, are `Claude `_
and `ChatGPT `_.
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 🎯
===============================================================================
Cost and Efficiency 💰
-------------------------------------------------------------------------------
* Cost optimization through GUI-based LLM services vs API billing.
* Support for batch operations instead of file-by-file interactions.
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.
* No premium subscriptions required.
* Works with LLM GUIs lacking project functionality.
Limitations and Alternatives 🔀
===============================================================================
* Manual refresh of files needed (no automatic sync).
* Cannot retract stale content from conversation history in provider GUIs.
* Consider dedicated tools (e.g., Cursor) for tighter collaboration loops.
Comparison of General Approaches ⚖️
-------------------------------------------------------------------------------
+---------------------+------------+------------+-------------+--------------+
| Feature | Mimeograms | Projects | Agents and | Specialized |
| | | (Web) [1]_ | Tools [3]_ | IDEs [2]_ |
+=====================+============+============+=============+==============+
| Cost Model | Flat rate | Flat rate | Usage-based | Flat rate |
+---------------------+------------+------------+-------------+--------------+
| Directory Structure | Yes | No | Yes [4]_ | Yes |
+---------------------+------------+------------+-------------+--------------+
| IDE Integration | Any | Web only | N/A | One |
+---------------------+------------+------------+-------------+--------------+
| Setup Required | CLI tool | None | SDK/Auth | Full install |
+---------------------+------------+------------+-------------+--------------+
| Version Control | Yes | No | Yes [4]_ | Yes |
+---------------------+------------+------------+-------------+--------------+
| Platform Support | Universal | Web | Universal | Limited |
+---------------------+------------+------------+-------------+--------------+
| Automation Support | Yes | No | Yes | Varies |
+---------------------+------------+------------+-------------+--------------+
.. [1] ChatGPT and Claude.ai subscription feature
.. [2] `Cursor `_, etc...
.. [3] `Claude Code `_, etc...
.. [4] Requires custom implementation
Notes:
- "Agents and Tools" refers to custom applications providing I/O tools
for LLMs to use via APIs, such as the Anthropic or OpenAI API.
- Cost differences can be significant at scale, especially when considering
cache misses against APIs.
Comparison with Similar Tools ⚖️
-------------------------------------------------------------------------------
- `ai-digest `_
- `dump_dir `_
- `Gitingest `_
- `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
`_
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 welcome. Please see the `contribution guide
`_
for:
* Code of Conduct
* Development Setup
* Coding Guidelines
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/.
`More Flair `_
===============================================================================
.. 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://img.shields.io/badge/security-bandit-yellow.svg
:alt: Bandit
:target: https://github.com/PyCQA/bandit
.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
:alt: Pylint
:target: https://github.com/pylint-dev/pylint
.. 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/