Skip to content

README.md

Latest commit

 

History

History
74 lines (57 loc) · 3.22 KB

README.md

File metadata and controls

74 lines (57 loc) · 3.22 KB
Raw

rtk-proxy

The local daemon that extends the RTK engine to your agent's provider-API traffic — compress, relay routed work, and more.

License: BUSL-1.1

rtk optimizes command output before it reaches your assistant's context. rtk-proxy brings the same engine to the API traffic itself: it sits between your AI coding tool and the real provider endpoint, runs the pipeline on the traffic — compression, and the relay of calls your pipeline routes to cheaper models — then relays the response back. It is agent-agnostic by design: it speaks the provider's dialect, not the agent's. Today Claude Code is wired, through rtk claude; other agents follow as their redirection is verified end to end.

It is a local daemon: one background process on your machine, driven by the rtk CLI. It does four things: intercept, compress, forward, record.

  Claude Code ──▶ rtk-proxy ──▶ api.anthropic.com
                     │
                     ├─ normalize: strip ANSI / redraws / dupes
                     ├─ your proxy.request.tool_result method rules
                     ├─ (opt-in) cache-align
                     └─ record usage ──▶ rtk gain

User documentation

Setup, what the daemon compresses, its settings and endpoints live in the user guide, docs/guide/proxy/, published at rtk-ai.app/guide:

Page Covers
RTK Proxy install, rtk claude, rtk init -g, --env, binding, state, savings
What the Proxy Compresses normalisation, cache alignment, your proxy.request rules
Proxy Configuration settings, provider dialects, HTTP endpoints, attribution headers 
rtk claude              # start the daemon if needed, then launch Claude through it
rtk llm-proxy status    # is it up
rtk gain                # savings, RTK and proxy side by side

Building

The crate lives in the rtk repository as its own workspace, and is not linked into the rtk CLI — rtk locates and spawns this binary.

cargo build --release --manifest-path proxy/Cargo.toml   # the daemon
cargo test --manifest-path proxy/Cargo.toml              # unit + functional + real-binary smoke

Contributing to the daemon: see docs/contributing/.

License

Business Source License 1.1 — source-available, not an OSI-approved open-source license. Its Additional Use Grant permits free production use, including running the daemon. What it does not permit is offering rtk-proxy, or a derivative, to third parties as a paid or hosted product or service — for that, contact contact@rtk-ai.app. On 2030-09-09 this version converts automatically to Apache-2.0.

This is a different license from the rtk CLI in the parent directory, which is Apache-2.0. The two are separate crates and separate binaries; rtk never links this code.