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 工具，避免讀取操作失敗。

📄 許可證

文檔未提及許可證信息，暫不提供。