Get API key

Coding agent plugin · v0.5.7

One install. Every agent. Fewer tokens.

Run supercompress setup to connect your account, detect coding agents, and auto-install MCP + hooks so large dumps get compressed before they burn tokens — Cursor, Claude Code, Codex, FreeBuff, OpenCode, Windsurf, Continue, Gemini, and more. Keep your normal login. Or use supercompress wrap claude for Headroom-style full-traffic auto-compress.

Install in 30 seconds 
npm install -g supercompress-proxy
supercompress setup
# full-traffic auto (optional):
supercompress wrap claude

npm install alone does not rewrite agent configs. setup / plugin links your account, installs MCP on every detected host, and adds Cursor/Claude/Codex hooks. Re-run anytime with supercompress plugin.

~65%fewer tokens
49agents catalogued
MCPsubscription-safe
~60mscompress latency

In this guide

  1. How it works
  2. Install
  3. Detect + plugin
  4. Supported agents
  5. MCP tools
  6. Dashboard
  7. Optional API proxy
  8. Uninstall

How it works

Three layers, best together:

  1. Hooks (Cursor / Claude Code / Codex) — every user message + large tool dumps auto-compress.
  2. MCP on every detected agent — compress_context for big dumps (subscription / login safe).
  3. Wrap — supercompress wrap claude starts the local proxy and launches the agent so all traffic is compressed (Headroom-style).
# Default — subscription / login safe (MCP + hooks)
Coding agent ──→ hooks / compress_context ──→ SuperCompress API

# Full-traffic auto
supercompress wrap claude ──→ localhost:8080 ──→ provider
Privacy The MCP server runs on your machine. Context is sent to the SuperCompress compression API so the hosted compiler can process it. Provider API keys never leave your agent — and MCP mode does not require them at all.

Install

npm install -g supercompress-proxy
supercompress --version
# → 0.5.7

Or one-shot without a global install:

npm install supercompress-proxy
npm exec supercompress setup

Detect + plugin

setup links your account and installs the MCP plugin. Prefer plugin anytime you add a new agent:

supercompress setup
supercompress plugin
$ supercompress plugin
✓ Detected Cursor, Claude Code, Codex, FreeBuff, OpenCode, …
✓ MCP plugin installed for: Cursor, FreeBuff, OpenCode, Codex MCP, …
✓ Cursor rule written
→ Works with login — no provider API-key mode
→ Restart your coding agent so MCP reloads
1
Install

Add supercompress-proxy with npm.

2
Link

supercompress setup opens the dashboard and connects your account.

3
Restart

Reload Cursor / Claude / Codex / FreeBuff / OpenCode so MCP servers load.

4
Compress

Ask the agent to compress large context — tool: compress_context.

Supported agents

The detector catalog covers 49 integrations. These get first-class MCP auto-plugin today:

Cursor

Writes ~/.cursor/mcp.json + always-on rule.

MCP

Claude Code

Registers in ~/.claude.json.

MCP

Codex

Updates ~/.codex/config.toml MCP block.

MCP

FreeBuff

Global Codebuff/FreeBuff MCP via ~/.agents/mcp.json.

MCP

OpenCode

Writes mcp.supercompress into opencode.jsonc.

MCP

Gemini CLI

Registers in Gemini settings MCP servers.

MCP

Also detected (manual endpoint / MCP where available)

WindsurfContinueClineAiderGooseOpenHandsRoo CodeCopilot CLIAmazon QPiCrush+ more

Run supercompress agents to see what is installed on your machine.

MCP tools

ToolWhat it does
compress_contextCompress bulky coding context for a query. Returns compressed text + savings.
connect_accountOpen the dashboard to link this install if you skipped setup.
usage_summaryPer-agent token savings for the connected SuperCompress account.

Dashboard tracking

After agents start compressing, your dashboard shows per-agent requests, tokens in/out/saved, and last-used time. Only usage metadata is sent — never prompt contents.

Optional API proxy

If you want the older base-URL rewrite path (provider API-key mode), opt in explicitly:

supercompress setup --proxy
supercompress start

That wires http://localhost:8080/v1 for compatible OpenAI/Anthropic endpoints. Most subscription/login agents should stay on the default MCP plugin path instead.

When to use --proxy Only when your agent already uses a provider API key and exposes a configurable OpenAI/Anthropic base URL. ChatGPT-login Codex and similar hosted backends are not intercepted by the local proxy — use MCP.

Uninstall

supercompress uninstall
npm uninstall -g supercompress-proxy

Uninstall removes MCP registrations, restores backed-up configs, and cleans ~/.supercompress.

Next: Usage →