diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 0ae617e1..5cf4ca7d 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -297,7 +297,7 @@ SHARED utils.rs Helpers N/A ✓ tee.rs Full output recovery N/A ✓ ``` -**Total: 67 modules** (45 command modules + 22 infrastructure modules) +**Total: 70 modules** (48 command modules + 22 infrastructure modules) ### Module Count Breakdown diff --git a/CLAUDE.md b/CLAUDE.md index 35ff19ed..c04fa508 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -22,6 +22,18 @@ rtk gain # Should show token savings stats (NOT "command not found") If `rtk gain` fails, you have the wrong package installed. +## Changelog Fragments + +Every PR needs a fragment in `changelog/fragments/{PR}-{slug}.yml`. Do NOT edit CHANGELOG.md directly. + +```bash +pnpm changelog:add # Interactive — creates the fragment file +pnpm changelog:validate # Validate a specific fragment +pnpm changelog:assemble --version x.y.z # Release time only — assembles into CHANGELOG.md +``` + +Fragment format documented in `changelog/schema.yml`. Required fields: `pr`, `type`, `scope`, `title`. + ## Development Commands > **Note**: If rtk is installed, prefer `rtk ` over raw commands for token-optimized output. @@ -615,3 +627,137 @@ rtk newcmd args # 7. Document # Update README.md, CHANGELOG.md, this file ``` + + +# 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`: +```bash +# ❌ 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) +```bash +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) +```bash +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 # Generic test wrapper - failures only +``` + +### Git (59-80% savings) +```bash +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) +```bash +rtk gh pr view # 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) +```bash +rtk pnpm list # Compact dependency tree (70%) +rtk pnpm outdated # Compact outdated packages (80%) +rtk pnpm install # Compact install output (90%) +rtk npm run