Skip to content
Merged
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
6 changes: 3 additions & 3 deletions .github/assets/banner-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions .github/assets/banner-phone-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions .github/assets/banner-phone.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions .github/assets/banner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
cff-version: 1.2.0
message: "If you use this work, cite it with this metadata and the release tag or commit you used."
title: "RGG"
title: "PascalsLetter"
type: software
authors:
- name: "RTK AI Labs"
- name: "EquityBot"
abstract: "A distribution of RTK: command output, compressed before your coding agent reads it."
repository-code: "https://github.com/EquityBot/rgg"
license-url: "https://github.com/EquityBot/rgg/blob/develop/LICENSE"
repository-code: "https://github.com/EquityBot/PascalsLetter"
license-url: "https://github.com/EquityBot/PascalsLetter/blob/develop/LICENSE"
keywords:
- claude-code
- cli
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ members = [".", "text", "engine", "plugin"]

[package]
name = "rtk"
version = "1.0.1+rgg"
version = "1.0.1+pascalsletter"
edition = "2024"
rust-version = "1.91"
authors = ["RTK AI Labs"]
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,33 @@
<source media="(max-width: 600px) and (prefers-color-scheme: light)" srcset=".github/assets/banner-phone-light.svg">
<source media="(max-width: 600px)" srcset=".github/assets/banner-phone.svg">
<source media="(prefers-color-scheme: light)" srcset=".github/assets/banner-light.svg">
<img src=".github/assets/banner.svg" width="100%" alt="RGG. Command output, compressed before your agent reads it. Pixel art of a funnel catching lines of text beside the RGG wordmark in slab-serif block letters.">
<img src=".github/assets/banner.svg" width="100%" alt="PascalsLetter. Command output, compressed before your agent reads it. Pixel art of a funnel catching lines of text beside the PascalsLetter wordmark in slab-serif block letters.">
</picture>
</p>

<div align="center">

[![CodeQL](https://github.com/EquityBot/rgg/actions/workflows/codeql.yml/badge.svg?branch=develop)](https://github.com/EquityBot/rgg/actions/workflows/codeql.yml) [![Codacy](https://app.codacy.com/project/badge/Grade/68c5d91770634f3b86493583fd8eada6?branch=develop)](https://app.codacy.com/gh/ryanduguid/rtk/dashboard)<br>
[![CodeQL](https://github.com/EquityBot/PascalsLetter/actions/workflows/codeql.yml/badge.svg?branch=develop)](https://github.com/EquityBot/PascalsLetter/actions/workflows/codeql.yml) [![Codacy](https://app.codacy.com/project/badge/Grade/68c5d91770634f3b86493583fd8eada6?branch=develop)](https://app.codacy.com/gh/ryanduguid/rtk/dashboard)<br>
[![rust: 1.91+](.github/assets/badges/rust.svg)](https://www.rust-lang.org/) [![licence: Apache-2.0 AND BUSL-1.1](.github/assets/badges/licence.svg)](#licence) [![fork of: RTK](.github/assets/badges/fork-of.svg)](https://github.com/rtk-ai/rtk)

[Install](#install) · [What RGG changes](#what-rgg-changes) · [Inherited from RTK](#inherited-from-rtk) · [Credits](#credits) · [Licence](#licence)
[Install](#install) · [What PascalsLetter changes](#what-pascalsletter-changes) · [Inherited from RTK](#inherited-from-rtk) · [Credits](#credits) · [Licence](#licence)

</div>

RGG is EquityBot's distribution of [RTK](https://github.com/rtk-ai/rtk), the Rust Token Killer. RTK filters and compresses command output before it reaches your coding agent's context: one Rust binary, more than 100 supported commands. RGG tracks upstream RTK and adds fixes where compression lost or mangled output an agent needed, several of them on Windows. It installs a binary named `rtk`, so hooks, agent configuration and every `rtk` command work unchanged.
PascalsLetter is EquityBot's distribution of [RTK](https://github.com/rtk-ai/rtk), the Rust Token Killer. RTK filters and compresses command output before it reaches your coding agent's context: one Rust binary, more than 100 supported commands. PascalsLetter tracks upstream RTK and adds fixes where compression lost or mangled output an agent needed, several of them on Windows. It installs a binary named `rtk`, so hooks, agent configuration and every `rtk` command work unchanged.

## Install

RGG has no prebuilt binaries. Build it from source with Rust:
PascalsLetter has no prebuilt binaries. Build it from source with Rust:

```bash
cargo install --git https://github.com/EquityBot/rgg rtk --locked
rtk --version # rtk 1.0.1+rgg
cargo install --git https://github.com/EquityBot/PascalsLetter rtk --locked
rtk --version # rtk 1.0.1+pascalsletter
```

RGG and upstream RTK both install `rtk`, so uninstall any Homebrew, winget or `install.sh` copy of RTK first. Add `--no-default-features` for the Apache-2.0-only build without the compression engine. Then set up your agent with `rtk init` as in [Quick Start](#quick-start). The `rtk-proxy` daemon is a separate package that this command does not install; build it with `cargo build --release --manifest-path proxy/Cargo.toml`.
PascalsLetter and upstream RTK both install `rtk`, so uninstall any Homebrew, winget or `install.sh` copy of RTK first. Add `--no-default-features` for the Apache-2.0-only build without the compression engine. Then set up your agent with `rtk init` as in [Quick Start](#quick-start). The `rtk-proxy` daemon is a separate package that this command does not install; build it with `cargo build --release --manifest-path proxy/Cargo.toml`.

## What RGG changes
## What PascalsLetter changes

Each change has a regression test, except `grep_max_results`.

Expand All @@ -48,7 +48,7 @@ Generally useful fixes are offered upstream as draft pull requests, listed in [F

## Inherited from RTK

Everything below describes RTK as RGG inherits it. Guide links go to this repository's copy of the RTK guide; its install commands install upstream RTK, not RGG.
Everything below describes RTK as PascalsLetter inherits it. Guide links go to this repository's copy of the RTK guide; its install commands install upstream RTK, not PascalsLetter.

rtk filters and compresses command outputs before they reach your LLM context. Single Rust binary, 100+ supported commands, <10ms overhead.

Expand Down Expand Up @@ -252,11 +252,11 @@ RTK collects **no command content and no file contents**. Telemetry is anonymous

## Credits

RGG is built on [RTK](https://github.com/rtk-ai/rtk) by rtk-ai, founded by Patrick Szymkowiak, with core contributors Florian Bruniaux, Adrien Eppling, Nicolas Le Cam and Takayuki Maeda. Translations of the upstream README: [Français](README_fr.md), [中文](README_zh.md), [日本語](README_ja.md), [한국어](README_ko.md), [Español](README_es.md) and [Português](README_pt.md).
PascalsLetter is built on [RTK](https://github.com/rtk-ai/rtk) by rtk-ai, founded by Patrick Szymkowiak, with core contributors Florian Bruniaux, Adrien Eppling, Nicolas Le Cam and Takayuki Maeda. Translations of the upstream README: [Français](README_fr.md), [中文](README_zh.md), [日本語](README_ja.md), [한국어](README_ko.md), [Español](README_es.md) and [Português](README_pt.md).

The banner's lettering and emblem are drawn from Cascadia Mono glyphs (SIL OFL 1.1).

Report RGG problems in this repository's issues. For RTK itself, use [rtk-ai/rtk](https://github.com/rtk-ai/rtk) or its [Discord](https://discord.gg/RySmvNF5kF).
Report PascalsLetter problems in this repository's issues. For RTK itself, use [rtk-ai/rtk](https://github.com/rtk-ai/rtk) or its [Discord](https://discord.gg/RySmvNF5kF).

## Licence

Expand Down
38 changes: 19 additions & 19 deletions llms.txt
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# RGG
# PascalsLetter

> EquityBot's distribution of RTK, the Rust Token Killer: one Rust binary that filters and
> compresses command output before it reaches a coding agent's context. It has no prebuilt
> binaries and installs a binary named `rtk`, as upstream RTK does, so uninstall any other RTK copy first.

Version `1.0.1+rgg`, built from source with
`cargo install --git https://github.com/EquityBot/rgg rtk --locked`. Add
Version `1.0.1+pascalsletter`, built from source with
`cargo install --git https://github.com/EquityBot/PascalsLetter rtk --locked`. Add
`--no-default-features` for the Apache-2.0-only build without the compression engine.

## Start

- [README](https://github.com/EquityBot/rgg#readme): install, what RGG changes from RTK and the licence terms.
- [Quick Start](https://github.com/EquityBot/rgg/blob/develop/docs/guide/getting-started/quick-start.md): set up an agent with `rtk init` and see the first savings.
- [How RTK Savings Work](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/savings-explained.md): what the savings figures measure and what they do not.
- [README](https://github.com/EquityBot/PascalsLetter#readme): install, what PascalsLetter changes from RTK and the licence terms.
- [Quick Start](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/getting-started/quick-start.md): set up an agent with `rtk init` and see the first savings.
- [How RTK Savings Work](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/resources/savings-explained.md): what the savings figures measure and what they do not.

## Docs

The guide is this repository's copy of the RTK guide; its install commands install upstream RTK, not RGG.
The guide is this repository's copy of the RTK guide; its install commands install upstream RTK, not PascalsLetter.

- [Configuration](https://github.com/EquityBot/rgg/blob/develop/docs/guide/getting-started/configuration.md): `config.toml`, environment variables and per-project filters.
- [Supported Agents](https://github.com/EquityBot/rgg/blob/develop/docs/guide/getting-started/supported-agents.md): set-up for each supported agent.
- [What RTK Optimizes](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/what-rtk-covers.md): commands and ecosystems covered.
- [Token Savings Analytics](https://github.com/EquityBot/rgg/blob/develop/docs/guide/analytics/gain.md): measuring savings with `rtk gain`.
- [Pipelines](https://github.com/EquityBot/rgg/blob/develop/docs/guide/pipelines/overview.md): composing the engine with `pipeline.toml`.
- [RTK Proxy](https://github.com/EquityBot/rgg/blob/develop/docs/guide/proxy/overview.md): the separate `rtk-proxy` daemon.
- [Editions and Licensing](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/editions.md): the Apache-2.0 edition and the BUSL-1.1 engine.
- [Telemetry & Privacy](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/telemetry.md): what is collected and how to opt out.
- [Troubleshooting](https://github.com/EquityBot/rgg/blob/develop/docs/guide/resources/troubleshooting.md): common issues and fixes.
- [Contributing](https://github.com/EquityBot/rgg/blob/develop/CONTRIBUTING.md): PR process and checks.
- [Security Policy](https://github.com/EquityBot/rgg/blob/develop/SECURITY.md): reporting a vulnerability.
- [Configuration](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/getting-started/configuration.md): `config.toml`, environment variables and per-project filters.
- [Supported Agents](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/getting-started/supported-agents.md): set-up for each supported agent.
- [What RTK Optimizes](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/resources/what-rtk-covers.md): commands and ecosystems covered.
- [Token Savings Analytics](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/analytics/gain.md): measuring savings with `rtk gain`.
- [Pipelines](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/pipelines/overview.md): composing the engine with `pipeline.toml`.
- [RTK Proxy](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/proxy/overview.md): the separate `rtk-proxy` daemon.
- [Editions and Licensing](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/resources/editions.md): the Apache-2.0 edition and the BUSL-1.1 engine.
- [Telemetry & Privacy](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/resources/telemetry.md): what is collected and how to opt out.
- [Troubleshooting](https://github.com/EquityBot/PascalsLetter/blob/develop/docs/guide/resources/troubleshooting.md): common issues and fixes.
- [Contributing](https://github.com/EquityBot/PascalsLetter/blob/develop/CONTRIBUTING.md): PR process and checks.
- [Security Policy](https://github.com/EquityBot/PascalsLetter/blob/develop/SECURITY.md): reporting a vulnerability.

## Related

- [EquityBot](https://github.com/EquityBot): other EquityBot tools.
- [RTK](https://github.com/rtk-ai/rtk): the upstream project RGG tracks.
- [RTK](https://github.com/rtk-ai/rtk): the upstream project PascalsLetter tracks.
2 changes: 1 addition & 1 deletion src/core/plugins_cmd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ fn dep_line(crate_name: &str, subpath: &str) -> String {
)
}
None => {
// A distribution build's `+rgg` metadata names no upstream tag.
// A distribution build's `+pascalsletter` metadata names no upstream tag.
let version = env!("CARGO_PKG_VERSION");
let tag = format!("v{}", version.split('+').next().unwrap_or(version));
format!("{crate_name} = {{ git = \"{GIT_URL}\", tag = \"{tag}\" }}")
Expand Down
Loading