From b725ef7ff4aabcf5a6b11257a9b9a7298bf0e20c Mon Sep 17 00:00:00 2001 From: Shawn Scott Date: Thu, 26 Mar 2026 15:02:13 -0700 Subject: [PATCH] docs: update grep command descriptions for passthrough behavior Documents the changes from rtk-ai/rtk#791: - grep now passes through raw output for <=50 matches (standard file:line:content) - grep uses grouped format only for >50 matches where token savings are meaningful - --no-ignore-vcs flag added to match grep -r behavior for .gitignore'd files - savings range updated to 0-90% to reflect passthrough for small result sets --- ARCHITECTURE.md | 2 +- INSTALL.md | 2 +- README.md | 2 +- README_es.md | 8 ++++---- README_fr.md | 8 ++++---- README_ja.md | 8 ++++---- README_ko.md | 8 ++++---- README_zh.md | 8 ++++---- docs/AUDIT_GUIDE.md | 2 +- docs/FEATURES.md | 2 +- 10 files changed, 25 insertions(+), 25 deletions(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 1a80e4d8..3e4ee4b2 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -172,7 +172,7 @@ Savings by ecosystem: RUBY (cmds/ruby/) 60-90% rake, rspec, rubocop DOTNET (cmds/dotnet/) 70-85% dotnet build/test, binlog CLOUD (cmds/cloud/) 60-80% aws, docker/kubectl, curl, wget, psql - SYSTEM (cmds/system/) 50-90% ls, tree, read, grep, find, json, log, env, deps + SYSTEM (cmds/system/) 0-90% ls, tree, read, grep, find, json, log, env, deps RUST (cmds/rust/) 60-99% cargo test/build/clippy, err ``` diff --git a/INSTALL.md b/INSTALL.md index 98457d09..aaba7d2c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -281,7 +281,7 @@ cp ~/.claude/settings.json.bak ~/.claude/settings.json ```bash rtk ls . # Compact tree view rtk read file.rs # Optimized reading -rtk grep "pattern" . # Grouped search results +rtk grep "pattern" . # Search results (raw <=50, grouped >50) ``` ### Git diff --git a/README.md b/README.md index 76d56520..5b24f8d6 100644 --- a/README.md +++ b/README.md @@ -142,7 +142,7 @@ rtk read file.rs # Smart file reading rtk read file.rs -l aggressive # Signatures only (strips bodies) rtk smart file.rs # 2-line heuristic code summary rtk find "*.rs" . # Compact find results -rtk grep "pattern" . # Grouped search results +rtk grep "pattern" . # Search results (raw <=50, grouped >50) rtk diff file1 file2 # Condensed diff ``` diff --git a/README_es.md b/README_es.md index c099d664..7ed98a39 100644 --- a/README_es.md +++ b/README_es.md @@ -10,7 +10,7 @@ CI Release License: MIT - Discord + Discord Homebrew

@@ -19,7 +19,7 @@ Instalar • Solucion de problemas • Arquitectura • - Discord + Discord

@@ -108,7 +108,7 @@ Cuatro estrategias: rtk ls . # Arbol de directorios optimizado rtk read file.rs # Lectura inteligente rtk find "*.rs" . # Resultados compactos -rtk grep "pattern" . # Busqueda agrupada por archivo +rtk grep "pattern" . # Resultados crudos <=50, agrupados >50 ``` ### Git @@ -152,7 +152,7 @@ rtk discover # Descubrir ahorros perdidos Las contribuciones son bienvenidas. Abre un issue o PR en [GitHub](https://github.com/rtk-ai/rtk). -Unete a la comunidad en [Discord](https://discord.gg/RySmvNF5kF). +Unete a la comunidad en [Discord](https://discord.gg/pvHdzAec). ## Licencia diff --git a/README_fr.md b/README_fr.md index 4c5e749d..1dc7bd1b 100644 --- a/README_fr.md +++ b/README_fr.md @@ -10,7 +10,7 @@ CI Release License: MIT - Discord + Discord Homebrew

@@ -19,7 +19,7 @@ Installer • Depannage • Architecture • - Discord + Discord

@@ -119,7 +119,7 @@ rtk ls . # Arbre de repertoires optimise rtk read file.rs # Lecture intelligente rtk read file.rs -l aggressive # Signatures uniquement rtk find "*.rs" . # Resultats compacts -rtk grep "pattern" . # Resultats groupes par fichier +rtk grep "pattern" . # Resultats bruts <=50, groupes >50 rtk diff file1 file2 # Diff condense ``` @@ -190,7 +190,7 @@ mode = "failures" Les contributions sont les bienvenues ! Ouvrez une issue ou une PR sur [GitHub](https://github.com/rtk-ai/rtk). -Rejoignez la communaute sur [Discord](https://discord.gg/RySmvNF5kF). +Rejoignez la communaute sur [Discord](https://discord.gg/pvHdzAec). ## Licence diff --git a/README_ja.md b/README_ja.md index 6c690aff..251ad345 100644 --- a/README_ja.md +++ b/README_ja.md @@ -10,7 +10,7 @@ CI Release License: MIT - Discord + Discord Homebrew

@@ -19,7 +19,7 @@ インストール • トラブルシューティング • アーキテクチャ • - Discord + Discord

@@ -108,7 +108,7 @@ git status # 自動的に rtk git status に書き換え rtk ls . # 最適化されたディレクトリツリー rtk read file.rs # スマートファイル読み取り rtk find "*.rs" . # コンパクトな検索結果 -rtk grep "pattern" . # ファイル別グループ化検索 +rtk grep "pattern" . # 50件以下は生出力、50件超はグループ化 ``` ### Git @@ -152,7 +152,7 @@ rtk discover # 見逃した節約機会を発見 コントリビューション歓迎！[GitHub](https://github.com/rtk-ai/rtk) で issue または PR を作成してください。 -[Discord](https://discord.gg/RySmvNF5kF) コミュニティに参加。 +[Discord](https://discord.gg/pvHdzAec) コミュニティに参加。 ## ライセンス diff --git a/README_ko.md b/README_ko.md index 5d3b1a0b..69824140 100644 --- a/README_ko.md +++ b/README_ko.md @@ -10,7 +10,7 @@ CI Release License: MIT - Discord + Discord Homebrew

@@ -19,7 +19,7 @@ 설치 • 문제 해결 • 아키텍처 • - Discord + Discord

@@ -108,7 +108,7 @@ git status # 자동으로 rtk git status로 재작성 rtk ls . # 최적화된 디렉토리 트리 rtk read file.rs # 스마트 파일 읽기 rtk find "*.rs" . # 컴팩트한 검색 결과 -rtk grep "pattern" . # 파일별 그룹화 검색 +rtk grep "pattern" . # 50개 이하 원본 출력, 50개 초과 그룹화 ``` ### Git @@ -152,7 +152,7 @@ rtk discover # 놓친 절약 기회 발견 기여를 환영합니다! [GitHub](https://github.com/rtk-ai/rtk)에서 issue 또는 PR을 생성해 주세요. -[Discord](https://discord.gg/RySmvNF5kF) 커뮤니티에 참여하세요. +[Discord](https://discord.gg/pvHdzAec) 커뮤니티에 참여하세요. ## 라이선스 diff --git a/README_zh.md b/README_zh.md index 00b9c001..45b20aac 100644 --- a/README_zh.md +++ b/README_zh.md @@ -10,7 +10,7 @@ CI Release License: MIT - Discord + Discord Homebrew

@@ -19,7 +19,7 @@ 安装 • 故障排除 • 架构 • - Discord + Discord

@@ -109,7 +109,7 @@ git status # 自动重写为 rtk git status rtk ls . # 优化的目录树 rtk read file.rs # 智能文件读取 rtk find "*.rs" . # 紧凑的查找结果 -rtk grep "pattern" . # 按文件分组的搜索结果 +rtk grep "pattern" . # 50条以下原始输出，50条以上分组 ``` ### Git @@ -160,7 +160,7 @@ rtk discover # 发现遗漏的节省机会 欢迎贡献！请在 [GitHub](https://github.com/rtk-ai/rtk) 上提交 issue 或 PR。 -加入 [Discord](https://discord.gg/RySmvNF5kF) 社区。 +加入 [Discord](https://discord.gg/pvHdzAec) 社区。 ## 许可证 diff --git a/docs/AUDIT_GUIDE.md b/docs/AUDIT_GUIDE.md index 8bcebdff..421953fd 100644 --- a/docs/AUDIT_GUIDE.md +++ b/docs/AUDIT_GUIDE.md @@ -270,7 +270,7 @@ Savings % = (Saved / Input) × 100 | `rtk vitest run` | 94-99% | Show failures only | | `rtk find` | 75% | Tree format | | `rtk pnpm list` | 70-90% | Compact dependencies | -| `rtk grep` | 70% | Truncate + group | +| `rtk grep` | 0-70% | Raw passthrough <=50 matches, group >50 | ## Database Management diff --git a/docs/FEATURES.md b/docs/FEATURES.md index 061a604a..883b1178 100644 --- a/docs/FEATURES.md +++ b/docs/FEATURES.md @@ -202,7 +202,7 @@ Supporte a la fois la syntaxe RTK et la syntaxe native `find` (`-name`, `-type`, ### `rtk grep` -- Recherche dans le contenu -**Objectif :** Remplace `grep` et `rg` avec une sortie groupee par fichier, tronquee. +**Objectif :** Remplace `grep` et `rg`. Passthrough brut pour <=50 resultats (format standard `file:line:content`), sortie groupee par fichier pour >50 resultats. Utilise `--no-ignore-vcs` pour correspondre au comportement de `grep -r` (respecte `.ignore`/`.rgignore`). **Syntaxe :** ```bash