mimeogram¶

📨 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 ⭐¶

📋 Clipboard Integration: Seamless copying and pasting by default.
🗂️ Directory Structure: Preserves hierarchical file organization.
🔄 Interactive Reviews: Review and apply proposed changes one by one.
🤖 LLM Integration: Built-in prompts and format instructions.
🛡️ 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.

Working with Simple LLM Interfaces¶

Use with API workbenches and with LLM GUIs which do not support persistent user-customized instructions (e.g., DeepSeek and Google Gemini):

Bundle files with mimeogram format instructions into clipboard.
```
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.
Apply mimeogram parts from clipboard. (On a terminal, this will be interactive by default.)
```
mimeogram apply
```

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.
```
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.
```
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).

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:

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:

~/.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¶

[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 🔀¶

LLMs must be prompted to understand and use mimeograms.
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 ⚖️¶

Feature	Mimeograms	Projects (Web) [1]	Direct API Integration	Specialized IDEs [2]
Cost Model	Flat rate	Flat rate	Usage-based	Flat rate
Directory Structure	Yes	No	Yes [3]	Yes
IDE Integration	Any	Web only	N/A	One
Setup Required	CLI tool	None	SDK/Auth	Full install
Version Control	Yes	No	Yes [3]	Yes
Platform Support	Universal	Web	Universal	Limited
Automation Support	Yes	No	Yes	Varies

Notes:

“Direct API Integration” 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.

Contributing 🤝¶

Contributions welcome. Please see the contribution guide for:

Code of conduct
Development setup
Coding guidelines
Documentation standards

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/.