mcpField
R
rtk

rtk

github.com/akillnessAgent 工作流53677 次安装4 天前更新
代码仓库

关于 rtk

rtk 是一项技能,用于安装、配置和排查 RTK 命令行工具;它会改写 shell 命令,减少发送给 AI 编码 Agent 的输出 Token。技能涵盖多种 Agent 的设置,并说明何时应直接运行 RTK 命令而非依赖钩子。

主要功能

  1. 01检查是否安装了正确的 RTK 二进制文件
  2. 02使用支持的方法安装或修复 RTK
  3. 03初始化特定 Agent 的钩子或配置
  4. 04运行 RTK 直接命令封装
  5. 05排查钩子、PATH 和安装问题

适用场景

  1. 01重新安装前核实现有 RTK 安装
  2. 02为支持的编码 Agent 配置 RTK
  3. 03钩子不可用时获取精简命令输出
  4. 04排查命令改写未生效的问题

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/akillness/jeo-skills --skill rtk

安装后在 Claude Code 中输入/rtk确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

SKILL.toon
agents/
openai.yaml
evals/
evals.json
references/
commands-and-config.md
install-and-verify.md
platform-init.md
troubleshooting.md
scripts/
check-status.sh
init-agent.sh
install.sh
skill-autoresearch-rtk/
changelog.md
dashboard.html
results.json
results.tsv
SKILL.md.baseline

详细介绍

rtk - 面向 AI 编码 Agent 的 Rust Token Killer

关键词:rtk · rust token killer · rtk init · rtk gain

目标仓库是 rtk-ai/rtk 的 akillness/rtk 分支。该分支跟踪上游代码,但随附的 install.sh 仍会从 rtk-ai/rtk 下载发布构件。

RTK 是一个高性能 CLI 代理,会在命令输出传递给 AI Agent 之前,将常见的 shell 命令改写为经过 Token 优化的等效命令。使用此技能可验证 RTK 二进制文件是否正确、安装或修复 RTK、为用户的 Agent 选择正确的 rtk init 模式;如果没有自动钩子,则改用直接运行 rtk 命令。

何时使用此技能

  • 验证是否已安装 RTK,以及安装的是否为正确项目
  • 修复常见的 cargo install rtk 名称冲突错误
  • 使用 Homebrew、仓库的 install.sh 或 Cargo 安装 RTK
  • 为 Claude Code、Codex、Gemini CLI、Cursor、Copilot、Windsurf、Cline 或 OpenCode 初始化 RTK
  • 说明何时 rtk init -g 比本地项目设置更合适
  • 使用 rtk git status、rtk read、rtk grep、rtk test 或 rtk lint 等直接 rtk 包装命令
  • 诊断自动改写未生效的原因
  • 说明内置文件工具不会经过 shell 钩子,以及何时应改用直接的 rtk 命令

指令

步骤 1:重新安装前,先验证当前安装

先运行本地状态检查助手:

bash scripts/check-status.sh --show

按以下顺序解读结果:

  1. 如果 rtk gain 可运行,则说明已安装正确的 RTK。除非用户希望升级,否则不要重新安装。
  2. 如果 rtk --version 可运行,但 rtk gain 失败,则用户很可能安装了错误的 rtk 软件包,通常是 Rust Type Kit。
  3. 如果完全找不到 rtk,则继续安装。

安装和验证决策树见 references/install-and-verify.md。

步骤 2:选择最适合的方式安装或修复 RTK

使用此包装器:

bash scripts/install.sh

安装方式的重要选择:

  • 默认的 auto 在 macOS 上优先使用 Homebrew(如果可用),然后使用该分支的 install.sh,最后使用 Cargo
  • Homebrew 可用且用户希望采用标准的系统管理安装方式时,使用 --method brew
  • 使用仓库安装脚本时,使用 --method script
  • 用户明确希望从 Git 源码构建或正在使用该分支时,使用 --method cargo
  • 用户已安装错误的 rtk 时,使用 --force-uninstall-wrong

示例:

bash scripts/install.sh --method brew
bash scripts/install.sh --method script
bash scripts/install.sh --method cargo --repo akillness/rtk
bash scripts/install.sh --force-uninstall-wrong

明确遵循以下安装规则:

  • 安装后始终使用 rtk gain 验证
  • 除非用户已确认软件包正确,否则不要轻易使用 cargo install rtk
  • 如果使用安装脚本,请记住该脚本仍会从 rtk-ai/rtk 获取发布构件
步骤 3:为 Agent 选择正确的 rtk init 模式

使用初始化包装器,而不是手动拼装标志:

bash scripts/init-agent.sh --agent claude --global

默认映射:

  • Claude Code:使用 --agent claude --global 进行钩子优先设置
  • Codex:使用 --agent codex --global,或使用本地模式 --agent codex --local
  • Gemini CLI:--agent gemini --global
  • Cursor:--agent cursor --global
  • Copilot:--agent copilot --global
  • OpenCode:--agent opencode --global
  • Windsurf:--agent windsurf --local
  • Cline / Roo Code:--agent cline --local

后续检查建议:

bash scripts/init-agent.sh --agent claude --global --auto-patch
bash scripts/init-agent.sh --agent codex --global
bash scripts/init-agent.sh --agent opencode --global
bash scripts/init-agent.sh --agent claude --show

如果用户需要了解各 Agent 的钩子类型、作用范围或卸载行为,请阅读 references/platform-init.md。

步骤 4:当钩子缺失或能力不足时,直接使用 RTK 命令

自动重写仅适用于 Agent 实际通过受支持的钩子或插件执行 shell 命令的情况。Codex、Windsurf 和 Cline 等仅基于提示词的集成仍可通过显式使用 rtk 命令获益,但它们不会透明地改写内置文件工具的操作。

以下情况请直接使用命令:

  • Agent 使用内置的 Read、Grep 或 Glob 工具,而不是 shell
  • 工作流使用 Codex,且用户希望立即获得精简输出
  • 用户希望进行不受钩子状态影响的确定性验证

常用命令:

rtk git status
rtk read src/main.rs
rtk grep "pattern" .
rtk test cargo test
rtk lint
rtk gain

命令系列和配置项汇总于 references/commands-and-config.md。

步骤 5:明确诊断故障

首先运行 bash scripts/check-status.sh --show 进行诊断,然后按以下情况处理:

  • 安装了错误的二进制文件:解决名称冲突并重新安装
  • 钩子缺失或已过时:重新运行正确的 rtk init 模式
  • Agent 仍然输出冗长内容:确认任务使用的是 shell 命令还是内置工具
  • PATH 问题:确保 ~/.local/bin 或 ~/.cargo/bin 位于 PATH 中
  • Windows 包装器故障:建议使用 RTK 0.23.1+

故障排查矩阵见 references/troubleshooting.md。

示例

示例 1:验证是否已安装正确的 RTK
bash scripts/check-status.sh --show
示例 2:使用支持 fork 的脚本路径进行安装
bash scripts/install.sh --method script --repo akillness/rtk
示例 3:修复错误的 cargo install rtk 软件包
bash scripts/install.sh --force-uninstall-wrong --method cargo
示例 4:Claude Code 全局钩子设置
bash scripts/init-agent.sh --agent claude --global --auto-patch
示例 5:Codex 全局提示词设置
bash scripts/init-agent.sh --agent codex --global
示例 6:安装 OpenCode 插件
bash scripts/init-agent.sh --agent opencode --global
示例 7:直接使用 RTK 获取精简输出
rtk read Cargo.toml
rtk grep "rtk init" README.md
rtk test cargo test
示例 8:临时绕过单条命令的重写
RTK_DISABLED=1 git status

最佳实践

  1. 重新安装前先检查 rtk gain;这是区分正确 RTK 和错误软件包的最快方法。
  2. 选择满足用户需求的最简安装方式:追求便利时使用 Homebrew,安装发布版二进制文件时使用安装脚本,基于源码的工作流使用 Cargo。
  3. 对支持钩子的 Agent,通常使用 rtk init -g;对 Windsurf 和 Cline,通常使用本地规则文件。
  4. 设置完成或升级后运行 rtk init --show,以便立即发现过时的钩子状态。
  5. 请记住,内置的读取/搜索工具不会经过 shell 钩子;若需节省令牌,请改用 shell 命令或直接使用 rtk 包装命令。
  6. 对于一次性直通命令,请考虑使用 RTK_DISABLED=1,而不是卸载钩子。
  7. RTK 升级后,请重新运行安装程序和 rtk init,因为钩子组件可能会随版本更新而变化。
  8. 当用户表示“RTK 出问题了”时,在提出修复方案前,先分别确认安装是否正确、钩子是否已注册,以及实际使用的命令路径。

参考资料

评论

支持 Markdown