Context compression sidecar for LLM applications. Reduce token costs 3-5x before calling any AI API.
Project description
๐๏ธ llm-zip
Context compression sidecar for LLM applications.
Reduce token costs 3โ5ร before calling any AI API.
Why ยท How it works ยท Quickstart ยท CLI ยท API response ยท File support ยท Benchmarks ยท Limitations ยท Contributing
Why llm-zip exists
AI inference is getting expensive. As context windows grow and agentic workflows multiply, the tokens you send to GPT, Claude, or Gemini compound fast โ and the "free ride" subsidy era is ending.
llm-zip was built out of a simple need: compress context before it reaches the model, without changing anything else in the stack. No proxy. No middleware. No API keys. Just a sidecar you call over HTTP, that hands back a smaller text and tells you exactly how much you saved.
It started as an internal tool. It's open source because the problem is universal.
Curious about how this started? Read STORY.md.
How it works
Your app โโโ POST /v1/estimate โโโ llm-zip
โ
counts tokens, estimates savings
(no compression โ CPU-free)
โ
token counts + savings โโโ
Your app โโโ POST /v1/compress โโโ llm-zip
โ
compresses with LLMLingua-2
scores semantic preservation
calculates USD savings
โ
compressed text + metrics โโโ
Your app โโโ calls OpenAI / Anthropic / Gemini
with the smaller context
llm-zip never touches your API keys or your model calls. It only compresses.
Quickstart
Requires Docker. First-time model download is ~700MB and takes 2โ5 min.
Step 1 โ Configure
Windows (CMD / PowerShell):
copy .llmzip.config.example .llmzip.config
notepad .llmzip.config
Linux / macOS:
cp .llmzip.config.example .llmzip.config
nano .llmzip.config
Step 2 โ Download models (only on first run)
docker-compose run llmzip download-models
Step 3 โ Start
docker-compose up -d
โ API: http://localhost:8000 ยท Docs: http://localhost:8000/docs
Running in split mode? See v0.2.0 release notes for
docker-compose.split.ymland separateDockerfile.api/Dockerfile.modelsโ lets you scale the API layer without duplicating the ~700MB model weights.
The CLI Experience
llm-zip isn't just an API โ it comes with a UNIX-friendly CLI powered by Typer and Rich. It supports stdin pipes, outputs clean JSON, and tracks live model prices.
# Check current prices (fetches live from LiteLLM)
$ llmzip prices -p anthropic
Rates from LiteLLM as of 2026-06-05
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโณโโโโโโโโโโโโโ
โ Model โ Input $/M โ Output $/M โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ anthropic.claude-3-5-sonnet-20241022-v2:0 โ 3.0000 โ 15.0000 โ
โ anthropic.claude-3-haiku-20240307-v1:0 โ 0.2500 โ 1.2500 โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโดโโโโโโโโโโโโโ
Model names come directly from LiteLLM and may use provider-specific naming (e.g. Bedrock-style). The exact list depends on live data at execution time.
# Compress directly from the terminal via pipes
$ cat huge_context.txt | llmzip compress --ratio 0.4 --model gpt-4o-mini > compressed.txt
โ 24000 โ 9600 tokens (2.5ร) | score: 0.92 | saved: ~$0.0021 (gpt-4o-mini)
What you get back
{
"compressed": "...",
"original_tokens": 8400,
"compressed_tokens": 1680,
"compression_ratio": 5.0,
"preservation_score": 0.91,
"estimated_savings": {
"gpt-4o-mini": "$0.0010",
"claude-haiku-4-5": "$0.0013",
"gemini-2.5-flash-lite": "$0.0006"
},
"skipped": false,
"warning": null
}
Prices are fetched live from LiteLLM with local caching โ no manual database updates needed.
MarkItDown Integration
One of the practical problems that motivated llm-zip was RAG over internal documents. In private systems โ invoices, reports, manuals, internal specs โ the source content lives in PDFs, Word files, and spreadsheets.
llm-zip integrates MarkItDown as an optional preprocessing layer. When FILE_CONVERSION=true, you can send a file directly to /v1/compress/file and get back compressed text ready for your RAG pipeline.
curl -X POST http://localhost:8000/v1/compress/file \
-F "file=@invoice.pdf" \
-F "ratio=0.5"
Supported formats: PDF, Word (.docx), Excel (.xlsx), PowerPoint (.pptx), and more.
Key Features
| Feature | Detail | |
|---|---|---|
| ๐ | Text and files | Compress plain text or upload PDFs, Word, Excel, and PowerPoint directly |
| ๐ช | Smart Chunking | Handle documents of any length by splitting text into chunks by paragraphs |
| ๐ | Optional auth | Protect your instance with API_KEY in config (Authorization: Bearer) |
| ๐ | Dry-run estimate | /v1/estimate calculates savings without compressing |
| ๐ | Split mode | Run API and inference engine as separate containers (DEPLOY_MODE=split) |
| ๐ฅ๏ธ | CPU-Friendly | Default model requires only ~700MB of RAM โ no GPU needed |
| ๐ | Global i18n | CLI in English, Spanish, Portuguese, Chinese, and Japanese |
| โ๏ธ | Configurable thresholds | Define when llm-zip should and shouldn't intervene (MIN_TOKENS_TO_COMPRESS) |
| ๐ซ | Ignore rules | Exclude texts or system prompts via .llmzipignore and .llmzipignore.local |
| ๐ | Self-hosted | Your data never leaves your infrastructure |
Environment Variables
For CI or Docker deployments, you can override defaults with environment variables:
| Variable | Description |
|---|---|
LLMZIP_LANG |
Forces CLI language (en, es, pt, zh, ja). Overrides system locale. |
DEPLOY_MODE |
monolith (default) or split โ separates API from inference container |
MODELS_URL |
URL of the models service in split mode (default: http://llmzip-models:8001) |
API_KEY |
Optional security key for /v1/* endpoints |
๐ The Science & Benchmarks
llm-zip is powered by Microsoft's LLMLingua-2. According to their research paper evaluated on the LongBench dataset:
- Compression sweet spot: optimal performance between 2ร and 5ร compression
- Quality retention: 90โ98% Exact Match performance vs. uncompressed prompts
- Latency reduction: end-to-end latency improvement of 1.6ร to 2.9ร (task-agnostic, no prompt needed to start)
๐งช Internal Test Results
The following results were obtained by running llm-zip against real documents during development. They are not synthetic benchmarks โ they reflect actual compression output on representative material.
How savings are calculated:
tokens_saved ร input_price_per_token, using live prices fetched from LiteLLM at run time. For OpenAI models, tokenization is exact (tiktoken). For Anthropic, Google and DeepSeek, a character-ratio heuristic is used (ยฑ10% margin). Only input token savings are counted โ output token reduction, which also occurs in many workflows, is not included. The figures below are approximate lower-bound estimates: real savings may be higher or lower depending on your actual usage pattern and the model you call.
| Document | Lang | Ratio | Tokens In | Tokens Out | Compression | Preservation | Est. Savingยน |
|---|---|---|---|---|---|---|---|
| A Survey of LLMs (100+ p.) | EN | def | 296,726 | 172,684 | 1.72ร | 0.9564 | ~$0.398 |
| Attention Is All You Need | EN | 0.5 | 11,993 | 6,240 | 1.92ร | 0.9087 | ~$0.016 |
| Generic customs manualยฒ (Technical) | ES | 0.9 | 11,996 | 4,765 | 2.52ร | 0.8942 | ~$0.018 |
ยน Estimated saving for
claude-sonnet-4-6input tokens only. See methodology note above. ยฒ Synthetic test dataset modeled after Argentine customs documentation (Cรณdigo Aduanero, NCM, ARCA/DGA). Not a real operational document.
๐ Hardware benchmarks (click to expand)
Community-maintained โ no verified numbers yet. If you run llm-zip on real hardware, please submit your results via PR.
| Hardware | Model | Tokens | Time |
|---|---|---|---|
| โ | โ | โ | โ |
๐ Use-case benchmarks (click to expand)
Community-maintained โ no verified numbers yet. If you use llm-zip in a real workload, please submit your results via PR.
| Use case | Tokens In | Ratio | Preservation | Est. Saving |
|---|---|---|---|---|
| โ | โ | โ | โ | โ |
Limitations & Caveats
- Language support โ LLMLingua-2 was trained on English meeting transcripts. Spanish and other languages work but may see 10โ15% lower compression quality. Community benchmarks are welcome.
- Extractive compression โ tokens are removed, not rewritten. Some nuance may be lost at aggressive ratios (above 0.7).
- Pricing accuracy โ savings are estimates. Non-OpenAI tokenizers use a character-ratio heuristic with a ยฑ10% margin of error.
- Format loss โ file conversion extracts plain text only. Layout, tables, and complex formatting are not preserved.
- Production testing โ this is v0.2.0. Concurrent batch processing should be monitored closely in high-throughput environments.
Contributing
The most valuable contributions right now are benchmark results across different languages, domains, and models. If you use llm-zip in a real project, a PR with your numbers helps everyone calibrate expectations.
Bug reports, feature requests, and code contributions are also welcome โ see CONTRIBUTING.md.
git clone https://github.com/finktech-dev/llm-zip.git
cd llm-zip
pip install -e ".[dev]"
pytest
License & Disclaimer
MIT ยฉ FinkTech
Built utilizing LLMLingua-2 and MarkItDown open-source libraries.
This project is an independent, community-driven open-source tool. It is not affiliated with, endorsed by, or sponsored by Microsoft Corporation, OpenAI, Anthropic, or any other LLM provider. All trademarks and registered trademarks are the property of their respective owners.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file llm_zip-0.2.2.tar.gz.
File metadata
- Download URL: llm_zip-0.2.2.tar.gz
- Upload date:
- Size: 49.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1936004982c6ddb93c00e841a8505e942545ec1bac9613c3a2978fb4d7e80698
|
|
| MD5 |
fa52684ad5cd53b7aaa5953ab2b7944d
|
|
| BLAKE2b-256 |
b523cbdaf5fe3fe5f9f55a8f151c731339edece421f1050763ce85cc55faab8a
|
File details
Details for the file llm_zip-0.2.2-py3-none-any.whl.
File metadata
- Download URL: llm_zip-0.2.2-py3-none-any.whl
- Upload date:
- Size: 55.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d7b5864da0bc35d4875ab80b53f8ccf4b755c1125eef2222a51daf764ac13af
|
|
| MD5 |
c2dd2dc110b988b8d4357d303a4517ad
|
|
| BLAKE2b-256 |
2a6781bce22e2a756b8d3dbcf25605cae4e7311f50acb7202d0f141e9b6656a6
|