❤️❤️❤️❤️❤️❤️ 我们已经正式推出微信小程序,在微信中搜索 TrendForge Pro 即可使用小程序,如果使用 Telegram 请搜索 trendforge_tg ❤️❤️❤️❤️❤️❤️

学习路径指南
难度等级
入门
预计时长
1-2小时
适合人群
零基础或初学者,希望优化AI编码助手令牌消耗的开发者

学习目标:学会安装、配置和使用rtk,将其集成到AI编码助手(如Claude Code)中,显著降低API调用成本。

前置知识

基本命令行操作 了解

需要能够在终端中执行命令,如导航目录、运行程序等。

Git基础知识 了解 (可选)

了解git status、git diff等基本命令,因为rtk主要优化这些命令的输出。

AI编码助手基本概念 了解 (可选)

了解Claude Code、GitHub Copilot等AI编码助手如何使用令牌(token)和上下文。

学习步骤

1

环境准备与安装

15分钟

选择安装方式

根据操作系统选择Homebrew(macOS/Linux)、Cargo或预编译二进制文件安装rtk。

推荐使用Homebrew(`brew install rtk-ai/rtk/rtk`)或快速安装脚本(`curl -fsSL https://rtk-ai.app/install.sh | sh`),最简单快捷。

验证安装

运行`rtk --version`确认安装成功,并检查是否与crates.io上的另一个同名项目混淆(如果`rtk gain`失败,说明安装错误)。

如果`rtk gain`报错,请使用`cargo install --git https://github.com/rtk-ai/rtk`重新安装。

Windows用户特殊设置

如果使用Windows,推荐安装WSL以获得完整支持。在原生Windows上,只能使用过滤功能,无法自动重写命令。

不要双击rtk.exe,它会在终端中运行并立即退出。

2

快速入门:手动使用rtk

20分钟

运行基本过滤命令

尝试`rtk ls -la`、`rtk git status`、`rtk cargo test`等命令,观察输出与原始命令的区别。

rtk会自动过滤注释、空白行和冗余信息,输出更紧凑。

查看令牌节省分析

运行`rtk gain`查看令牌节省统计,了解rtk为你节省了多少。

这个命令会显示节省百分比和具体数值,是衡量rtk效果的关键指标。

使用全局标志

尝试`rtk --verbose git status`查看详细输出,或`rtk --dry-run git status`预览过滤效果而不实际执行。

`--dry-run`非常适合调试,可以看到rtk会如何修改输出。

3

集成到AI编码助手

30分钟

为Claude Code设置自动重写钩子

运行`rtk init -g`,这将安装一个钩子,自动将Claude Code中的Bash命令重写为rtk版本。

重启Claude Code后生效。注意:钩子只影响Bash工具调用,内置的Read、Grep等工具不会自动重写。

为其他AI工具设置集成

根据使用的AI工具(如GitHub Copilot、Cursor等),运行相应的初始化命令,例如`rtk init -g --copilot`。

查看README中的表格,选择对应工具的安装命令。

测试集成是否生效

在AI编码助手内执行一个命令(如`git status`),检查输出是否被rtk过滤(更紧凑)。

如果输出没有变化,检查钩子是否正确安装,或查看故障排除指南。

4

配置与自定义

20分钟

编辑配置文件

找到配置文件位置(Linux: `~/.config/rtk/config.toml`,macOS: `~/Library/Application Support/rtk/config.toml`),查看默认设置。

配置文件使用TOML格式,可以调整过滤策略、排除某些命令等。

配置失败命令的回退

在配置文件中设置`[passthrough]`部分,当命令失败时,rtk会保存完整输出供LLM读取。

这确保AI助手不会因为过滤而丢失重要错误信息。

调整过滤策略

根据需要启用或禁用智能过滤、分组、截断和去重策略。

不同项目类型可能需要不同的策略组合,建议先使用默认设置,再根据`rtk gain`结果微调。

推荐资源

rtk用户指南 必看

完整的用户指南,涵盖安装、配置、故障排除等所有内容。

配置指南 推荐

详细的配置参考,包括所有配置项和环境变量。

支持的AI工具指南 推荐

为不同AI编码助手设置集成的详细步骤。

Discord社区 推荐

加入Discord社区,与其他用户交流、提问和获取帮助。

架构文档 可选

了解rtk的系统设计和技术决策,适合进阶学习。

学习路径常见错误

1

安装错误版本(安装到crates.io上的另一个rtk项目)

安装后运行`rtk gain`测试,如果失败,使用`cargo install --git https://github.com/rtk-ai/rtk`重新安装。

2

在Windows上双击rtk.exe运行

始终在终端中运行rtk(Command Prompt、PowerShell或Windows Terminal),不要双击exe文件。

3

期望钩子能自动重写所有AI工具的内置命令

钩子只影响Bash工具调用。对于内置的Read、Grep、Glob等工具,需要使用shell命令(如cat、rg、find)或显式调用rtk命令(如rtk read、rtk grep)。

4

忘记重启AI编码助手

安装或更新钩子后,必须重启AI编码助手(如Claude Code)才能使更改生效。

5

认为rtk会改变原始命令行为

rtk只过滤和压缩命令的输出,不会修改原始命令的执行。如果命令失败,rtk会保存完整输出供AI读取。

学习路径下一步步骤

学完基础后,可以深入学习:1) 为不同项目配置自定义过滤规则;2) 分析`rtk gain`数据,优化过滤策略;3) 探索rtk的架构和贡献指南,参与开源贡献;4) 了解如何为其他AI工具(如Hermes、OpenCode)编写插件适配器。

助手