63 lines
2.5 KiB
Markdown
63 lines
2.5 KiB
Markdown
## Engineering Principles
|
|
|
|
Apply YAGNI, KISS, and DRY whenever practical:
|
|
|
|
- **YAGNI (You Aren't Gonna Need It):** Implement current requirements. Avoid
|
|
speculative features, abstractions, configuration, and dependencies.
|
|
- **KISS (Keep It Simple):** Choose the simplest clear, maintainable solution
|
|
that meets the requirements. Avoid unnecessary complexity and indirection.
|
|
- **DRY (Don't Repeat Yourself):** Reuse existing code and centralize shared
|
|
logic and knowledge when appropriate. Avoid premature abstractions that
|
|
couple unrelated behavior merely because it looks similar.
|
|
- **Modern industry standards:** Follow current, widely accepted standards and
|
|
idiomatic practices for the language, framework, security, and accessibility
|
|
relevant to the task. Respect supported runtimes and project constraints;
|
|
verify evolving guidance when needed and avoid adopting novelty for its own
|
|
sake.
|
|
|
|
Use judgment when these principles conflict, and briefly explain material
|
|
tradeoffs or exceptions.
|
|
|
|
<!-- headroom:rtk-instructions -->
|
|
# RTK (Rust Token Killer) - Token-Optimized Commands
|
|
|
|
When running shell commands, **always prefix with `rtk`**. This reduces context
|
|
usage by 60-90% with zero behavior change. If rtk has no filter for a command,
|
|
it passes through unchanged — so it is always safe to use.
|
|
|
|
## Key Commands
|
|
```bash
|
|
# Git (59-80% savings)
|
|
rtk git status rtk git diff rtk git log
|
|
|
|
# Files & Search (60-75% savings)
|
|
rtk ls <path> rtk read <file> rtk grep <pattern>
|
|
rtk find <pattern> rtk diff <file>
|
|
|
|
# Test (90-99% savings) — shows failures only
|
|
rtk pytest tests/ rtk cargo test rtk test <cmd>
|
|
|
|
# Build & Lint (80-90% savings) — shows errors only
|
|
rtk tsc rtk lint rtk cargo build
|
|
rtk prettier --check rtk mypy rtk ruff check
|
|
|
|
# Analysis (70-90% savings)
|
|
rtk err <cmd> rtk log <file> rtk json <file>
|
|
rtk summary <cmd> rtk deps rtk env
|
|
|
|
# GitHub (26-87% savings)
|
|
rtk gh pr view <n> rtk gh run list rtk gh issue list
|
|
|
|
# Infrastructure (85% savings)
|
|
rtk docker ps rtk kubectl get rtk docker logs <c>
|
|
|
|
# Package managers (70-90% savings)
|
|
rtk pip list rtk pnpm install rtk npm run <script>
|
|
```
|
|
|
|
## Rules
|
|
- In command chains, prefix each segment: `rtk git add . && rtk git commit -m "msg"`
|
|
- For debugging, use raw command without rtk prefix
|
|
- `rtk proxy <cmd>` runs command without filtering but tracks usage
|
|
<!-- /headroom:rtk-instructions -->
|