Skip to content

AGENTS.md

Latest commit

 

History

History
181 lines (148 loc) · 6.77 KB

AGENTS.md

File metadata and controls

181 lines (148 loc) · 6.77 KB
Raw

RTK (Rust Token Killer) - Token-Optimized Commands

Golden Rule

Always prefix commands with rtk. If RTK has a dedicated filter, it uses it. If not, it passes through unchanged. This means RTK is always safe to use.

Important: Even in command chains with &&, use rtk:

# ❌ Wrong
git add . && git commit -m "msg" && git push

# ✅ Correct
rtk git add . && rtk git commit -m "msg" && rtk git push

RTK Commands by Workflow

Build & Compile (80-90% savings)

rtk cargo build         # Cargo build output
rtk cargo check         # Cargo check output
rtk cargo clippy        # Clippy warnings grouped by file (80%)
rtk tsc                 # TypeScript errors grouped by file/code (83%)
rtk lint                # ESLint/Biome violations grouped (84%)
rtk prettier --check    # Files needing format only (70%)
rtk next build          # Next.js build with route metrics (87%)

Test (90-99% savings)

rtk cargo test          # Cargo test failures only (90%)
rtk vitest run          # Vitest failures only (99.5%)
rtk playwright test     # Playwright failures only (94%)
rtk test <cmd>          # Generic test wrapper - failures only

Git (59-80% savings)

rtk git status          # Compact status
rtk git log             # Compact log (works with all git flags)
rtk git diff            # Compact diff (80%)
rtk git show            # Compact show (80%)
rtk git add             # Ultra-compact confirmations (59%)
rtk git commit          # Ultra-compact confirmations (59%)
rtk git push            # Ultra-compact confirmations
rtk git pull            # Ultra-compact confirmations
rtk git branch          # Compact branch list
rtk git fetch           # Compact fetch
rtk git stash           # Compact stash
rtk git worktree        # Compact worktree

Note: Git passthrough works for ALL subcommands, even those not explicitly listed.

GitHub (26-87% savings)

rtk gh pr view <num>    # Compact PR view (87%)
rtk gh pr checks        # Compact PR checks (79%)
rtk gh run list         # Compact workflow runs (82%)
rtk gh issue list       # Compact issue list (80%)
rtk gh api              # Compact API responses (26%)

JavaScript/TypeScript Tooling (70-90% savings)

rtk pnpm list           # Compact dependency tree (70%)
rtk pnpm outdated       # Compact outdated packages (80%)
rtk pnpm install        # Compact install output (90%)
rtk npm run <script>    # Compact npm script output
rtk npx <cmd>           # Compact npx command output
rtk prisma              # Prisma without ASCII art (88%)

Files & Search (60-75% savings)

rtk ls <path>           # Tree format, compact (65%)
rtk read <file>         # Code reading with filtering (60%)
rtk grep <pattern>      # Search grouped by file (75%)
rtk find <pattern>      # Find grouped by directory (70%)

Analysis & Debug (70-90% savings)

rtk err <cmd>           # Filter errors only from any command
rtk log <file>          # Deduplicated logs with counts
rtk json <file>         # JSON structure without values
rtk deps                # Dependency overview
rtk env                 # Environment variables compact
rtk summary <cmd>       # Smart summary of command output
rtk diff                # Ultra-compact diffs

Infrastructure (85% savings)

rtk docker ps           # Compact container list
rtk docker images       # Compact image list
rtk docker logs <c>     # Deduplicated logs
rtk kubectl get         # Compact resource list
rtk kubectl logs        # Deduplicated pod logs

Network (65-70% savings)

rtk curl <url>          # Compact HTTP responses (70%)
rtk wget <url>          # Compact download output (65%)

Meta Commands

rtk gain                # View token savings statistics
rtk gain --history      # View command history with savings
rtk discover            # Analyze Codex sessions for missed RTK usage
rtk proxy <cmd>         # Run command without filtering (for debugging)
rtk init                # Add RTK instructions to AGENTS.md
rtk init --global       # Add RTK to ~/.Codex/AGENTS.md

Token Savings Overview

Category Commands Typical Savings
Tests vitest, playwright, cargo test 90-99%
Build next, tsc, lint, prettier 70-87%
Git status, log, diff, add, commit 59-80%
GitHub gh pr, gh run, gh issue 26-87%
Package Managers pnpm, npm, npx 70-90%
Files ls, read, grep, find 60-75%
Infrastructure docker, kubectl 85%
Network curl, wget 65-70%

Overall average: 60-90% token reduction on common development operations.

RepoInsight 项目架构

技术栈优先级说明：以下技术栈为优先选择，如需更换必须询问。

整体架构（SDD 切分方式）

Backend Core（Rust / Python）

通过 Tauri 命令调用或本地服务：

  • Scanner：文件遍历 + ignore 规则处理
  • Analyzers：tech stack 检测、TODO 提取、metadata、structure、dependency 等模块，可独立扩展
  • Reporter / Data Processor：生成结构化数据

Frontend（React + Vite + Tailwind）

  • 交互界面、树状图、统计可视化、报告展示

通信方式

Tauri 的 invoke / events（安全、零端口暴露）

存储

本地缓存扫描结果（可选 SQLite 或 JSON 文件），支持最近打开仓库列表

技术栈优先级

以下技术栈为默认选择，更换前必须询问：

层级 技术 备注
核心语言 Rust / Python Backend Core
前端框架 React + Vite + Tailwind 交互界面
桌面框架 Tauri 打包与通信
本地存储 SQLite / JSON 扫描结果缓存

编码规范

  • 所有文本文件统一使用 UTF-8 编码读写。
  • 新建或修改 .md、.ts、.tsx、.js、.json、.rs、.css、.html、.yml、.yaml 文件时，必须显式按 UTF-8 处理，禁止回退到系统默认编码、GBK、ANSI 或其他本地代码页。
  • 在 Windows PowerShell 中读写文件时，优先使用显式 UTF-8 参数或等效方式，避免因终端代码页导致乱码。
  • 如果发现中文文本异常，先判断是“显示层解码错误”还是“文件内容已被错误编码后再次保存”，不要直接在乱码内容上继续覆盖写入。

环境约束

  • 不要使用apply_patch 操作文件；
  • 直接使用windows环境，不要使用沙箱环境；
  • 当前默认运行环境是 Windows，默认 Shell 是 PowerShell 7。
  • 编写或执行命令时，应优先使用 PowerShell 7 语法与 Windows 路径约定，不要默认按 Bash、zsh 或 Linux shell 语法处理。
  • 如果命令需要跨平台兼容，请在文档或实现中显式说明差异，不要隐式依赖 Unix-only 行为。