docs: revamp README with logo, badges, and structure cleanup (#371)
* docs: revamp README with logo, badges, and cleaner structure
- Add centered logo (og-image) and tagline
- Add badges: CI, release version, license, Discord, Homebrew
- Add language links placeholder (fr, zh, ja, ko, es)
- Fix Linux binary filename (gnu -> musl) — fixes #323
- Put Homebrew as recommended install method
- Simplify and reorganize all sections (871 -> ~360 lines)
- Add Discord invite link
- Remove verbose troubleshooting (link to TROUBLESHOOTING.md instead)
- Remove detailed security review section (link to SECURITY.md)
* docs: add translated READMEs (fr, zh, ja, ko, es)
Add localized README files linked from the main README language selector:
- README_fr.md (French)
- README_zh.md (Chinese)
- README_ja.md (Japanese)
- README_ko.md (Korean)
- README_es.md (Spanish)
Each translation includes: installation, quick start, commands overview,
how it works diagram, and links to documentation.
* docs: use rtk-ai org avatar as logo in all READMEs
2026-03-06 12:01:06 +01:00
|
|
|
|
<p align="center">
|
|
|
|
|
|
<img src="https://avatars.githubusercontent.com/u/258253854?v=4" alt="RTK - Rust Token Killer" width="500">
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
|
<strong>LLM トークン消費を 60-90% 削減する高性能 CLI プロキシ</strong>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
|
<a href="https://github.com/rtk-ai/rtk/actions"><img src="https://github.com/rtk-ai/rtk/workflows/Security%20Check/badge.svg" alt="CI"></a>
|
|
|
|
|
|
<a href="https://github.com/rtk-ai/rtk/releases"><img src="https://img.shields.io/github/v/release/rtk-ai/rtk" alt="Release"></a>
|
|
|
|
|
|
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
2026-03-23 10:13:44 +01:00
|
|
|
|
<a href="https://discord.gg/RySmvNF5kF"><img src="https://img.shields.io/discord/1478373640461488159?label=Discord&logo=discord" alt="Discord"></a>
|
docs: revamp README with logo, badges, and structure cleanup (#371)
* docs: revamp README with logo, badges, and cleaner structure
- Add centered logo (og-image) and tagline
- Add badges: CI, release version, license, Discord, Homebrew
- Add language links placeholder (fr, zh, ja, ko, es)
- Fix Linux binary filename (gnu -> musl) — fixes #323
- Put Homebrew as recommended install method
- Simplify and reorganize all sections (871 -> ~360 lines)
- Add Discord invite link
- Remove verbose troubleshooting (link to TROUBLESHOOTING.md instead)
- Remove detailed security review section (link to SECURITY.md)
* docs: add translated READMEs (fr, zh, ja, ko, es)
Add localized README files linked from the main README language selector:
- README_fr.md (French)
- README_zh.md (Chinese)
- README_ja.md (Japanese)
- README_ko.md (Korean)
- README_es.md (Spanish)
Each translation includes: installation, quick start, commands overview,
how it works diagram, and links to documentation.
* docs: use rtk-ai org avatar as logo in all READMEs
2026-03-06 12:01:06 +01:00
|
|
|
|
<a href="https://formulae.brew.sh/formula/rtk"><img src="https://img.shields.io/homebrew/v/rtk" alt="Homebrew"></a>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
|
<a href="https://www.rtk-ai.app">ウェブサイト</a> •
|
|
|
|
|
|
<a href="#インストール">インストール</a> •
|
|
|
|
|
|
<a href="docs/TROUBLESHOOTING.md">トラブルシューティング</a> •
|
|
|
|
|
|
<a href="ARCHITECTURE.md">アーキテクチャ</a> •
|
2026-03-23 10:13:44 +01:00
|
|
|
|
<a href="https://discord.gg/RySmvNF5kF">Discord</a>
|
docs: revamp README with logo, badges, and structure cleanup (#371)
* docs: revamp README with logo, badges, and cleaner structure
- Add centered logo (og-image) and tagline
- Add badges: CI, release version, license, Discord, Homebrew
- Add language links placeholder (fr, zh, ja, ko, es)
- Fix Linux binary filename (gnu -> musl) — fixes #323
- Put Homebrew as recommended install method
- Simplify and reorganize all sections (871 -> ~360 lines)
- Add Discord invite link
- Remove verbose troubleshooting (link to TROUBLESHOOTING.md instead)
- Remove detailed security review section (link to SECURITY.md)
* docs: add translated READMEs (fr, zh, ja, ko, es)
Add localized README files linked from the main README language selector:
- README_fr.md (French)
- README_zh.md (Chinese)
- README_ja.md (Japanese)
- README_ko.md (Korean)
- README_es.md (Spanish)
Each translation includes: installation, quick start, commands overview,
how it works diagram, and links to documentation.
* docs: use rtk-ai org avatar as logo in all READMEs
2026-03-06 12:01:06 +01:00
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
|
<a href="README.md">English</a> •
|
|
|
|
|
|
<a href="README_fr.md">Francais</a> •
|
|
|
|
|
|
<a href="README_zh.md">中文</a> •
|
|
|
|
|
|
<a href="README_ja.md">日本語</a> •
|
|
|
|
|
|
<a href="README_ko.md">한국어</a> •
|
|
|
|
|
|
<a href="README_es.md">Espanol</a>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
rtk はコマンド出力を LLM コンテキストに届く前にフィルタリング・圧縮します。単一の Rust バイナリ、依存関係ゼロ、オーバーヘッド 10ms 未満。
|
|
|
|
|
|
|
|
|
|
|
|
## トークン節約（30分の Claude Code セッション）
|
|
|
|
|
|
|
|
|
|
|
|
| 操作 | 頻度 | 標準 | rtk | 節約 |
|
|
|
|
|
|
|------|------|------|-----|------|
|
|
|
|
|
|
| `ls` / `tree` | 10x | 2,000 | 400 | -80% |
|
|
|
|
|
|
| `cat` / `read` | 20x | 40,000 | 12,000 | -70% |
|
|
|
|
|
|
| `grep` / `rg` | 8x | 16,000 | 3,200 | -80% |
|
|
|
|
|
|
| `git status` | 10x | 3,000 | 600 | -80% |
|
|
|
|
|
|
| `cargo test` / `npm test` | 5x | 25,000 | 2,500 | -90% |
|
|
|
|
|
|
| **合計** | | **~118,000** | **~23,900** | **-80%** |
|
|
|
|
|
|
|
|
|
|
|
|
## インストール
|
|
|
|
|
|
|
|
|
|
|
|
### Homebrew（推奨）
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
brew install rtk
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### クイックインストール（Linux/macOS）
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
curl -fsSL https://raw.githubusercontent.com/rtk-ai/rtk/refs/heads/master/install.sh | sh
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Cargo
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
cargo install --git https://github.com/rtk-ai/rtk
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### 確認
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
rtk --version # "rtk 0.27.x" と表示されるはず
|
|
|
|
|
|
rtk gain # トークン節約統計が表示されるはず
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## クイックスタート
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
# 1. Claude Code 用フックをインストール（推奨）
|
|
|
|
|
|
rtk init --global
|
|
|
|
|
|
|
|
|
|
|
|
# 2. Claude Code を再起動してテスト
|
|
|
|
|
|
git status # 自動的に rtk git status に書き換え
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 仕組み
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
rtk なし： rtk あり：
|
|
|
|
|
|
|
|
|
|
|
|
Claude --git status--> shell --> git Claude --git status--> RTK --> git
|
|
|
|
|
|
^ | ^ | |
|
|
|
|
|
|
| ~2,000 tokens（生出力） | | ~200 tokens | フィルタ |
|
|
|
|
|
|
+-----------------------------------+ +------- （圧縮済）----+----------+
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
4つの戦略：
|
|
|
|
|
|
|
|
|
|
|
|
1. **スマートフィルタリング** - ノイズを除去（コメント、空白、ボイラープレート）
|
|
|
|
|
|
2. **グルーピング** - 類似項目を集約（ディレクトリ別ファイル、タイプ別エラー）
|
|
|
|
|
|
3. **トランケーション** - 関連コンテキストを保持、冗長性をカット
|
|
|
|
|
|
4. **重複排除** - 繰り返しログ行をカウント付きで統合
|
|
|
|
|
|
|
|
|
|
|
|
## コマンド
|
|
|
|
|
|
|
|
|
|
|
|
### ファイル
|
|
|
|
|
|
```bash
|
|
|
|
|
|
rtk ls . # 最適化されたディレクトリツリー
|
|
|
|
|
|
rtk read file.rs # スマートファイル読み取り
|
|
|
|
|
|
rtk find "*.rs" . # コンパクトな検索結果
|
|
|
|
|
|
rtk grep "pattern" . # ファイル別グループ化検索
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Git
|
|
|
|
|
|
```bash
|
|
|
|
|
|
rtk git status # コンパクトなステータス
|
|
|
|
|
|
rtk git log -n 10 # 1行コミット
|
|
|
|
|
|
rtk git diff # 圧縮された diff
|
|
|
|
|
|
rtk git push # -> "ok main"
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### テスト
|
|
|
|
|
|
```bash
|
|
|
|
|
|
rtk test cargo test # 失敗のみ表示（-90%）
|
|
|
|
|
|
rtk vitest run # Vitest コンパクト
|
|
|
|
|
|
rtk pytest # Python テスト（-90%）
|
|
|
|
|
|
rtk go test # Go テスト（-90%）
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### ビルド & リント
|
|
|
|
|
|
```bash
|
|
|
|
|
|
rtk lint # ESLint ルール別グループ化
|
|
|
|
|
|
rtk tsc # TypeScript エラーグループ化
|
|
|
|
|
|
rtk cargo build # Cargo ビルド（-80%）
|
|
|
|
|
|
rtk ruff check # Python リント（-80%）
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### 分析
|
|
|
|
|
|
```bash
|
|
|
|
|
|
rtk gain # 節約統計
|
|
|
|
|
|
rtk gain --graph # ASCII グラフ（30日間）
|
|
|
|
|
|
rtk discover # 見逃した節約機会を発見
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## ドキュメント
|
|
|
|
|
|
|
|
|
|
|
|
- **[TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)** - よくある問題の解決
|
|
|
|
|
|
- **[INSTALL.md](INSTALL.md)** - 詳細インストールガイド
|
|
|
|
|
|
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - 技術アーキテクチャ
|
|
|
|
|
|
|
|
|
|
|
|
## コントリビュート
|
|
|
|
|
|
|
|
|
|
|
|
コントリビューション歓迎！[GitHub](https://github.com/rtk-ai/rtk) で issue または PR を作成してください。
|
|
|
|
|
|
|
2026-03-23 10:13:44 +01:00
|
|
|
|
[Discord](https://discord.gg/RySmvNF5kF) コミュニティに参加。
|
docs: revamp README with logo, badges, and structure cleanup (#371)
* docs: revamp README with logo, badges, and cleaner structure
- Add centered logo (og-image) and tagline
- Add badges: CI, release version, license, Discord, Homebrew
- Add language links placeholder (fr, zh, ja, ko, es)
- Fix Linux binary filename (gnu -> musl) — fixes #323
- Put Homebrew as recommended install method
- Simplify and reorganize all sections (871 -> ~360 lines)
- Add Discord invite link
- Remove verbose troubleshooting (link to TROUBLESHOOTING.md instead)
- Remove detailed security review section (link to SECURITY.md)
* docs: add translated READMEs (fr, zh, ja, ko, es)
Add localized README files linked from the main README language selector:
- README_fr.md (French)
- README_zh.md (Chinese)
- README_ja.md (Japanese)
- README_ko.md (Korean)
- README_es.md (Spanish)
Each translation includes: installation, quick start, commands overview,
how it works diagram, and links to documentation.
* docs: use rtk-ai org avatar as logo in all READMEs
2026-03-06 12:01:06 +01:00
|
|
|
|
|
|
|
|
|
|
## ライセンス
|
|
|
|
|
|
|
|
|
|
|
|
MIT ライセンス - 詳細は [LICENSE](LICENSE) を参照。
|