Universal context intelligence layer — compresses LLM context across CLI, MCP, browser, and IDE
Project description
███████╗ ██████╗ ███████╗ ██╔════╝██╔═══██╗╚══███╔╝ ███████╗██║ ██║ ███╔╝ ╚════██║██║▄▄ ██║ ███╔╝ ███████║╚██████╔╝███████╗ ╚══════╝ ╚══▀▀═╝ ╚══════╝ The Context Intelligence Layer
Compress LLM context to save tokens and reduce costs — Shell Hook + MCP Server + Browser Extension + IDE Extensions
sqz: Compress what is safe, preserve what is critical.
Single Rust binary · Zero telemetry · 586 tests · 60 property-based correctness proofs
Install · How It Works · Features · Platforms · Changelog · Discord
The Problem
AI coding tools waste tokens. Every file read sends the full content — even if the LLM saw it 30 seconds ago. Every git status sends raw output. Every API response dumps uncompressed JSON. You're paying for tokens that carry zero signal.
The Solution
sqz sits between your AI tool and the LLM, compressing everything before it reaches the model. The real win isn't just compression — it's deduplication. When the same file gets read 5 times in a session, sqz sends it once and returns a 13-token reference for every subsequent read.
Without sqz: With sqz:
File read #1: 2,000 tokens File read #1: ~800 tokens (compressed)
File read #2: 2,000 tokens File read #2: ~13 tokens (dedup ref)
File read #3: 2,000 tokens File read #3: ~13 tokens (dedup ref)
───────────────────────── ─────────────────────────
Total: 6,000 tokens Total: ~826 tokens (86% saved)
No workflow changes. Install once, save on every API call.
Token Savings
sqz saves tokens in two ways: compression (removing noise from content) and deduplication (replacing repeated reads with 13-token references). The dedup cache is where the biggest savings happen in real sessions.
Where sqz shines
| Scenario | Savings | Why |
|---|---|---|
| Repeated file reads (5x) | 86% | Dedup cache: 13-token ref after first read |
| JSON API responses with nulls | 7–56% | Strip nulls + TOON encoding (varies by null density) |
| Repeated log lines | 58% | Condense stage collapses duplicates |
| Large JSON arrays | 77% | Array sampling + collapse |
Where sqz intentionally preserves content
| Scenario | Savings | Why |
|---|---|---|
| Stack traces | 0% | Error content is critical — safe mode preserves it |
| Test output | 0% | Pass/fail signals must not be altered |
| Short git output | 0% | Already compact, nothing to strip |
This is by design. sqz's confidence router detects high-risk content (errors, test results, diffs) and routes it through safe mode to avoid dropping signal. A tool that claims 89% compression on cargo test output is either lying or deleting your error messages.
Benchmark suite
Command: cargo test -p sqz-engine benchmarks -- --nocapture
For a full session-level comparison with rtk, see docs/benchmark-vs-rtk.md.
| Case | Before | After | Saved |
|---|---|---|---|
| repeated_logs | 148 | 62 | 58.1% |
| json_api | 64 | 59 | 7.8% |
| git_diff | 61 | 54 | 11.5% |
| large_json_array | 259 | 60 | 76.8% |
| stack_trace (safe mode) | 82 | 82 | 0.0% |
| prose_docs | 124 | 124 | 0.0% |
Track your savings
sqz gain # ASCII chart of daily token savings
sqz stats # Cumulative compression report
Install
# Confirmed working:
cargo install sqz-cli
# Coming soon (scaffolded, not yet live):
# curl -fsSL https://raw.githubusercontent.com/ojuschugh1/sqz/main/install.sh | sh
# brew install sqz
# npm install -g sqz-cli
# pip install sqz
All install channels point to github.com/ojuschugh1/sqz.
Then:
sqz init
That's it. Shell hooks installed, default presets created, ready to go.
How It Works
sqz operates at four integration levels simultaneously:
1. Shell Hook (CLI Proxy)
Intercepts command output from 100+ CLI tools (git, cargo, npm, docker, kubectl, aws, etc.) and compresses it before the LLM sees it.
# Before: git log sends ~800 tokens of raw output
# After: sqz compresses to ~150 tokens, same information
2. MCP Server
A compiled Rust binary (not Node.js) that serves as an MCP server with intelligent tool selection, preset hot-reload, and an 8-stage compression pipeline.
{
"mcpServers": {
"sqz": {
"command": "sqz-mcp",
"args": ["--transport", "stdio"]
}
}
}
3. Browser Extension
Chrome and Firefox extensions for ChatGPT, Claude.ai, Gemini, Grok, and Perplexity. Compresses pasted content client-side via a lightweight WASM engine (TOON encoding + whitespace normalization + phrase substitution). The full 8-stage pipeline runs in the CLI/MCP — the browser uses a fast subset optimized for paste-time latency. Zero network requests.
4. IDE Extensions
Native VS Code and JetBrains extensions that intercept file reads at the editor level, with AST-aware compression for 18 languages and a status bar showing token budget.
Features
Compression Engine
- 8-stage pipeline — keep_fields, strip_fields, condense, strip_nulls, flatten, truncate_strings, collapse_arrays, custom_transforms
- TOON encoding — lossless JSON compression producing compact ASCII-safe output (reduction varies by structure, 4-30% typical)
- Tree-sitter AST — structural code extraction for 4 languages natively (Rust, Python, JavaScript, Bash) + 14 via regex fallback (TypeScript, Go, Java, C, C++, Ruby, JSON, HTML, CSS, C#, Kotlin, Swift, TOML, YAML)
- Image compression — screenshots → semantic DOM descriptions
- ANSI auto-strip — removes color codes before compression
Caching & Memory
- SHA-256 file cache — on a miss, content is compressed and stored; on a hit, the engine returns a compact inline reference (~13 tokens) instead of resending the full payload. LRU eviction, persisted across sessions. (Rust API:
CacheResult::DedupvsFresh.) - SQLite FTS5 session store — cross-session memory with full-text search (
Sessionin code;SessionStateis a compatibility alias) - Correction log — immutable append-only log that survives compaction
- CTX format — portable session graph across Claude, GPT, and Gemini
Intelligence
- Prompt cache awareness — preserves Anthropic 90% and OpenAI 50% cache boundaries
- Dynamic tool selection — exposes 3-5 relevant tools per task via semantic matching
- Model routing — routes simple tasks to cheaper local models
- Terse mode — system prompt injection for concise LLM responses (3 levels)
- Predictive budget warnings — alerts at 70% and 85% thresholds
Cost & Analytics
- Real-time USD tracking — per-tool breakdown with cache discount impact
- Multi-agent budgets — per-agent allocation with isolation and enforcement
- Session cost summaries — total tokens, USD, cache savings, compression savings
Extensibility
- TOML presets — hot-reload within 2 seconds, community-driven ecosystem
- Plugin API — Rust trait + WASM interface for custom compression strategies
- 150 CLI patterns — git, cargo, npm, docker, kubectl, aws, and more
Privacy
- Zero telemetry — no data transmitted, no crash reports, no analytics
- Fully offline — works in air-gapped environments after install
- Local only — all processing happens on your machine
Platforms
sqz integrates with AI coding tools across 3 levels:
Level 1 — MCP Config Only
Continue · Zed
Level 2 — Shell Hook + MCP
Claude Code · Cursor · Copilot · Windsurf · Gemini CLI · Codex · OpenCode · Goose · Aider · Amp
Level 3 — Native / Deep
VS Code · JetBrains · Chrome (ChatGPT, Claude.ai, Gemini, Grok, Perplexity)
See docs/integrations/ for platform-specific setup guides.
CLI Commands
sqz init # Install shell hooks + default presets
sqz compress <text> # Compress text (or pipe from stdin)
sqz compress --verify # Compress with confidence score
sqz compress --mode safe|aggressive # Force compression mode
sqz stats # Cumulative compression report
sqz gain # ASCII chart of daily token savings
sqz gain --days 30 # Last 30 days
sqz analyze <file> # Per-block Shannon entropy analysis
sqz export <session> # Export session to .ctx format
sqz import <file> # Import a .ctx file
sqz status # Show token budget and usage
sqz cost <session> # Show USD cost breakdown
Configuration
sqz uses TOML presets with hot-reload. The [preset] table maps to the Rust PresetHeader type (name, version, optional description).
[preset]
name = "default"
version = "1.0"
[compression]
stages = ["keep_fields", "strip_fields", "condense", "strip_nulls",
"flatten", "truncate_strings", "collapse_arrays", "custom_transforms"]
[compression.condense]
enabled = true
max_repeated_lines = 3
[compression.strip_nulls]
enabled = true
[budget]
warning_threshold = 0.70
ceiling_threshold = 0.85
default_window_size = 200000
[terse_mode]
enabled = true
level = "moderate"
[model]
family = "anthropic"
primary = "claude-sonnet-4-20250514"
complexity_threshold = 0.4
Architecture
┌─────────────────────────────────────────────────────┐
│ Integration Surfaces │
│ CLI Binary │ MCP Server │ Browser │ IDE Ext │
└──────┬───────┴──────┬───────┴─────┬─────┴─────┬─────┘
│ │ │ │
└──────────────┴─────────────┴────────────┘
│
┌──────────────────┴──────────────────┐
│ sqz_engine (Rust core) │
│ │
│ Compression Pipeline (8 stages) │
│ TOON Encoder (lossless JSON) │
│ AST Parser (tree-sitter + regex, 18 langs) │
│ Cache manager (SHA-256 file cache) │
│ Session Store (SQLite FTS5) │
│ Budget Tracker (multi-agent) │
│ Cost Calculator (real-time USD) │
│ Tool Selector (semantic matching) │
│ Prompt Cache Detector │
│ Model Router (complexity routing) │
│ Correction Log (append-only) │
│ Plugin API (Rust + WASM) │
└─────────────────────────────────────┘
Distribution
| Channel | Command | Status |
|---|---|---|
| Cargo | cargo install sqz-cli |
Live |
| Homebrew | brew install sqz |
Coming soon |
| npm | npm install -g sqz-cli / npx sqz-cli |
Coming soon |
| pip | pip install sqz |
Coming soon |
| curl | curl -fsSL .../install.sh | sh |
Coming soon |
| Docker | docker run sqz |
Coming soon |
| GitHub Releases | Pre-built binaries for Linux, macOS, Windows | Coming soon |
Development
git clone https://github.com/ojuschugh1/sqz.git
cd sqz
cargo test --workspace # 586 tests
cargo build --release # optimized binary
Rust API names (sqz_engine)
Prefer the primary type names below; the second name in each row is a type alias kept for compatibility.
| Primary | Alias |
|---|---|
Session |
SessionState |
Turn |
ConversationTurn |
PinnedSegment |
PinEntry |
KvFact |
Learning |
WindowUsage |
BudgetState |
ToolCall |
ToolUsageRecord |
EditRecord |
CorrectionEntry |
EditHistory |
CorrectionLog |
PresetHeader |
PresetMeta |
File cache: CacheManager returns CacheResult::Dedup (compact inline reference) or CacheResult::Fresh (newly compressed payload).
Sandbox: SandboxResult uses status_code, was_truncated, and was_indexed (stdout-only data enters the context window).
Project Structure
sqz_engine/ Core Rust library (all compression logic)
sqz/ CLI binary (shell hooks, commands)
sqz-mcp/ MCP server binary (stdio/SSE transport)
sqz-wasm/ WASM target for browser extension
extension/ Chrome extension (content scripts, popup)
vscode-extension/ VS Code extension (TypeScript)
jetbrains-plugin/ JetBrains plugin (Kotlin)
docs/ Integration guides and documentation
Testing
The test suite includes 586 tests with 60 property-based correctness properties validated via proptest:
- TOON round-trip fidelity
- Compression preserves semantically significant content
- ASCII-safe output across all inputs
- File cache — deduplication, hits, and invalidation
- Budget token count invariants
- Pin/unpin compaction round-trips
- CTX format round-trip serialization
- Plugin priority ordering
- Tool selection cardinality bounds
- Cross-tokenizer determinism
Contributing
We welcome contributions. By submitting a pull request, you agree to the Contributor License Agreement.
See CONTRIBUTING.md for the development workflow.
License
Licensed under Elastic License 2.0 (ELv2). You can use, fork, modify, and distribute sqz freely. Two restrictions: you cannot offer it as a competing hosted/managed service, and you cannot remove licensing notices.
We chose ELv2 over MIT because MIT permits repackaging the code as a competing closed-source SaaS — ELv2 prevents that while keeping the source available to everyone.
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 sqz-0.2.0.tar.gz.
File metadata
- Download URL: sqz-0.2.0.tar.gz
- Upload date:
- Size: 11.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f717264820b182503661edf71a70aa9b300b9b7d319db0cb8fce57df8d8c672f
|
|
| MD5 |
d8619f2afdb9357191ea29689b06bb45
|
|
| BLAKE2b-256 |
8a4db6c4e17d76ad69ae8537682feedcd7ed9ce26ae39d49ea17a6c849eed4af
|
File details
Details for the file sqz-0.2.0-py3-none-any.whl.
File metadata
- Download URL: sqz-0.2.0-py3-none-any.whl
- Upload date:
- Size: 10.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
07bb18b37dc9fe0eb47eb5230cf90f996fa40d519e773f12b1858883325f4832
|
|
| MD5 |
25a327f645d9e9a486039970eb2f99e0
|
|
| BLAKE2b-256 |
e0e230b6f52fa2073b66a25987d6765f835cfa77eb6dc47b17ade5eed62b54a6
|