Documentation

Everything you need to install, configure, and understand Squeezr.

Getting Started

Installation

Install Squeezr globally via npm. Node.js 18+ required, Windows/macOS/Linux/WSL supported.

Quick Start

Two commands to get up and running: npm install + squeezr setup.

Setup

What squeezr setup does: env vars, shell wrapper, auto-start, CA trust.

Claude Code

System prompt caching, tool dedup, adaptive pressure. Works automatically after setup.

Codex

MITM proxy on port 8081, TLS interception. Set HTTPS_PROXY per-session only.

Aider

Anthropic and OpenAI model support, repo map compression, cross-turn dedup.

Gemini CLI

Works automatically after setup via GEMINI_API_BASE_URL.

Ollama & LM Studio

Local models as both target and compression backend. Free end-to-end.

Cursor IDE

BYOK + Override Base URL. Chat and agent modes compressed. Use squeezr tunnel if localhost fails.

Continue Extension

VS Code and JetBrains. No tunnel needed — http://localhost:8080/v1 works directly.

Configuration

squeezr.toml reference, env vars, per-project .squeezr.toml overrides.

Compression Pipeline

3-layer pipeline: system prompt cache, deterministic preprocessing, 30+ tool patterns.

Patterns

30+ patterns for git, tests, builds, infra, package managers, and more.

Caching

In-process LRU cache, KV warming, session expand store.

CLI Commands

setup, start, stop, status, update, logs, config, ports, gain, discover, uninstall, version.

Config File

Complete squeezr.toml reference with all sections and defaults.

API Endpoints

Health, stats, expand endpoints and proxy routing table.

Expand Tool

How squeezr_expand() works and its lossless retrieval mechanism.

Having issues?

Check the troubleshooting guide for common problems and solutions.

Troubleshooting