Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -417,8 +417,8 @@ HEADROOM_DOCKER_MEMORY_LIMIT=512m
HEADROOM_DOCKER_CPU_LIMIT=1.0
HEADROOM_DOCKER_RESTART_POLICY=unless-stopped
# HEADROOM_DOCKER_NETWORK=lynkr-network
# HEADROOM_DOCKER_BUILD_CONTEXT=./headroom-sidecar
# HEADROOM_DOCKER_AUTO_BUILD=true
HEADROOM_DOCKER_BUILD_CONTEXT=./headroom-sidecar
HEADROOM_DOCKER_AUTO_BUILD=true # Auto-build image if not found (recommended)

# ==============================================================================
# Headroom Transform Settings
Expand Down Expand Up @@ -468,6 +468,13 @@ TOON_LOG_STATS=true
CAVEMAN_ENABLED=false
CAVEMAN_LEVEL=lite

# ==============================================================================
# Lynkr Wrap Mode (lynkr wrap claude)
# ==============================================================================

# Show compression/routing stats on exit (default: true)
LYNKR_WRAP_SHOW_STATS=true

# ==============================================================================
# Tiered Model Routing (REQUIRED)
# ==============================================================================
Expand Down
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,40 @@

---

## πŸš€ New: Wrap Mode for AI Coding Tools

**Use Lynkr's routing with your AI coding assistant β€” maximize your subscription value:**

```bash
npm install -g lynkr

# Claude Code Pro/Max
lynkr wrap claude

# GitHub Copilot
lynkr wrap copilot

# Aider
lynkr wrap aider

# Cursor
lynkr wrap cursor

# OpenAI Codex
lynkr wrap codex
```

**Wrapping gives you:**
- βœ… Tier routing (send simple tasks to free Ollama, complex to your subscription/API)
- βœ… TOON/RTK compression (87% token reduction on tool outputs)
- βœ… Semantic caching (171ms cache hits)
- βœ… **3-5x more usage from the same subscription limits**
- βœ… Works with OAuth (Claude, Copilot, Cursor) or API keys (Aider, Codex)

[Full wrap guide β†’](docs/wrap-guide.md)

---

## Quick Start (2 Minutes)

### 1. Install Lynkr
Expand Down
2 changes: 2 additions & 0 deletions bin/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const pkg = require('../package.json');
const SUBCOMMANDS = {
usage: path.join(__dirname, "lynkr-usage.js"),
trajectory: path.join(__dirname, "lynkr-trajectory.js"),
wrap: path.join(__dirname, "wrap.js"),
};

const sub = process.argv[2];
Expand All @@ -30,6 +31,7 @@ ${pkg.description}

Usage:
lynkr [options] Start the proxy server (default)
lynkr wrap <target> [options] Wrap CLI tools through Lynkr proxy
lynkr usage [options] Show AI spend report and tier-routing savings
lynkr trajectory [options] Export agent trajectories as JSONL training data

Expand Down
Loading
Loading