Rlm

🚀 RLM Hooks

RLM Hooks 中的 Large File Suggester Hook 可在文件超过配置的阈值时，拦截 Read 工具调用并建议使用 RLM 工具。

✨ 主要特性

• 拦截 Read 工具调用，当文件超过可配置的阈值时，建议使用 RLM 工具。
• 可分别配置文件大小阈值和令牌数量阈值。
• 提供手动测试和集成测试方法，方便验证功能。
• 支持自定义阈值，满足不同场景需求。
• 给出建议的 RLM 工作流，避免上下文膨胀并处理超过令牌限制的文件。

📦 安装指南

文档未提及安装步骤，暂不提供。

💻 使用示例

基础用法

手动测试

1. 创建一个大的测试文件（>25KB）：

python3 -c "print('x' * 150000)" > /tmp/large_file.txt

2. 直接测试钩子：

# 使用大文件进行测试（应显示建议）
echo '{"tool_input": {"file_path": "/tmp/large_file.txt"}}' | .claude/hooks/check-file-size.sh

# 预期输出：
# {
#   "decision": "approve",
#   "reason": "This file is 146.48 KB ..."
# }

3. 使用小文件进行测试（不应显示建议）：

echo '{"tool_input": {"file_path": "/Users/richard/projects/fun/rlm/README.md"}}' | .claude/hooks/check-file-size.sh

# 预期输出：
# {"decision": "approve"}

4. 测试边界情况：

# 不存在的文件
echo '{"tool_input": {"file_path": "/nonexistent.txt"}}' | .claude/hooks/check-file-size.sh
# 输出: {"decision": "approve"}

# 没有 file_path
echo '{"tool_input": {}}' | .claude/hooks/check-file-size.sh
# 输出: {"decision": "approve"}

自定义阈值

大小阈值（RLM_SIZE_THRESHOLD，以字节为单位）：

# 使用 50KB 大小阈值
RLM_SIZE_THRESHOLD=51200 echo '{"tool_input": {"file_path": "somefile.txt"}}' | .claude/hooks/check-file-size.sh

# 使用 1MB 大小阈值
RLM_SIZE_THRESHOLD=1048576 echo '{"tool_input": {"file_path": "somefile.txt"}}' | .claude/hooks/check-file-size.sh

令牌阈值（RLM_TOKEN_THRESHOLD，以令牌为单位）：

# 使用 5K 令牌阈值（更激进，捕获较小的文件）
RLM_TOKEN_THRESHOLD=5000 echo '{"tool_input": {"file_path": "somefile.txt"}}' | .claude/hooks/check-file-size.sh

# 使用 20K 令牌阈值（接近硬限制）
RLM_TOKEN_THRESHOLD=20000 echo '{"tool_input": {"file_path": "somefile.txt"}}' | .claude/hooks/check-file-size.sh

同时设置两个阈值：

# 自定义大小（100KB）和令牌（15K）阈值
RLM_SIZE_THRESHOLD=102400 RLM_TOKEN_THRESHOLD=15000 .claude/hooks/check-file-size.sh

与 Claude Code 进行集成测试

1. 在 RLM 项目目录中启动 Claude Code。
2. 要求 Claude 读取一个大文件（>25KB）。
3. 在读取文件之前观察建议消息。
4. 读取操作仍将继续（不会被阻止）。

高级用法

当钩子触发时，建议使用以下 RLM 工作流：

1. rlm_load_context(name, content) - 作为外部变量加载。
2. rlm_inspect_context(name) - 获取结构而不加载完整内容。
3. rlm_chunk_context(name, 'paragraphs') - 进行策略性拆分。
4. rlm_sub_query_batch(query, name, indices) - 并行处理。

这种模式可防止上下文膨胀，并能够处理超过令牌限制的文件。

📚 详细文档

行为

当满足以下任一阈值时触发：

• 大小阈值：25KB（可通过 RLM_SIZE_THRESHOLD 环境变量配置）。
• 令牌阈值：10K 令牌（可通过 RLM_TOKEN_THRESHOLD 环境变量配置）。

令牌估计采用每个令牌约 4 个字符（保守估计）。

为什么令牌阈值很重要：Claude 的 Read 工具在 25K 令牌时会硬性失败。10K 令牌阈值可提前发出警告，以便在达到硬限制之前使用 RLM。

• 操作：建议使用 RLM 工具，但不阻止读取操作。
• 输出：包含 decision: "approve" 和可选 reason 消息的 JSON。

配置

钩子在 .claude/settings.json 中进行配置：

{
  "hooks": {
    "PreToolUse": [
      {
        "matcher": "Read",
        "hooks": [
          {
            "type": "command",
            "command": ".claude/hooks/check-file-size.sh"
          }
        ]
      }
    ]
  }
}

文件结构

.claude/
  hooks/
    check-file-size.sh     # 钩子脚本
    rlm-suggest.json       # 钩子元数据（可选，用于文档说明）
    README.md              # 本文件
  settings.json            # 钩子配置

🔧 技术细节

令牌估计采用每个令牌约 4 个字符的保守估计，这是为了在接近 Claude 的 Read 工具 25K 令牌硬限制之前，能提前通过 10K 令牌阈值发出警告，让用户有机会使用 RLM 工具，避免读取操作失败。

📄 许可证

文档未提及许可证信息，暂不提供。