claude-cache-keepalive 0.1.5 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -23,8 +23,8 @@ This puts a `cwarm` command on your PATH (npm creates both the Unix and Windows
23
23
  ## Usage
24
24
 
25
25
  ```sh
26
- cwarm # = claude --continue, inside the keepalive host
27
- cwarm new # any claude args are passed straight through
26
+ cwarm # = plain `claude`, inside the keepalive host (no implicit --continue)
27
+ cwarm --continue # resume your last session; any claude args pass straight through
28
28
  cwarm resume
29
29
  cwarm -p "..."
30
30
  cwarm --version # (passed through → prints claude's version)
@@ -101,27 +101,69 @@ Environment variables (mostly for testing / advanced use):
101
101
  > ⚠️ **誠實說明**:保溫=閒置時送一則小訊息(`hi`),會消耗你的方案用量、並在對話留下 `hi` 紀錄。只在長時間閒置後才觸發(1h cache 約 58 分、5m cache 約 4 分)且有冷卻,屬保守設計、明確 opt‑in。不接受這個取捨就別用。
102
102
 
103
103
  - **安裝**:`npm install -g claude-cache-keepalive`
104
- - **使用**:`cwarm`(=`claude --continue` 跑在保溫 host 裡;其餘參數原樣轉給 claude)
104
+ - **使用**:`cwarm`(=乾淨的 `claude` 跑在保溫 host 裡,不再隱含 `--continue`;要接續上次打 `cwarm --continue`,其餘參數原樣轉給 claude)
105
105
  - **暫停**:`touch ~/.claude/cwarm.disabled`;**紀錄**:`~/.claude/cwarm-keepalive.log`
106
106
  - **選配 statusline**(顯示 `♻️ cache 58m12s` 倒數;會先備份、包裝既有 statusline、可一鍵還原):`cwarm setup` / `cwarm setup --remove`
107
107
  - **限制**:不能 detach(關視窗=結束,但縮小/背景照常保溫)。
108
108
 
109
+ ### 運作原理
110
+
111
+ - **PTY host**:`cwarm` 把 `claude` spawn 在一個它自己擁有的 pseudo-terminal 裡,透明地把你的鍵盤 ↔ claude ↔ 畫面(含視窗 resize)接起來。這跟 tmux/expect/VS Code 終端的做法相同,也是唯一穩健、能把輸入注入終端程式的方式。
112
+ - **閒置偵測**:閒置=距你上次**訊息**多久,量自 `~/.claude/projects/` 底下最新的 transcript 檔。這才是決定 cache 年齡的訊號——捲動、用方向鍵讀、打到一半沒送出,都是終端輸入但不會刷新 cache,所以不該算成活動。(早期版本計時鍵盤輸入,會讓你在閱讀時 cache 冷掉。)
113
+ - **TTL 感知(實測,非猜測)**:cache TTL 直接讀自 transcript 的 `message.usage.cache_creation`,不從訂閱方案推斷——最近有寫 `ephemeral_1h_input_tokens` → 1h cache(閒置約 58 分才注入、冷卻 1h);只有 `ephemeral_5m_input_tokens`(或還沒證據)→ 5m cache(保守,約 4 分注入、冷卻 5m)。這能撐過 client 版本、環境變數、伺服器旗標的變動(例如 Pro 帳號也可能拿到 1h cache)。
114
+ - **提示安全注入**:keepalive 只在 PTY **靜止一小段時間後**才觸發(`CWARM_QUIET_MS`,預設 2.5 秒)。必答提示(工具權限、`AskUserQuestion`、計畫批准)的 spinner 會一直動,忙著跑工具時也持續輸出,兩者都「不安靜」,所以 keepalive 不會送進去(不會誤選選單預設項、也不會打斷長工具執行)。而且注入時會**先送 `Esc`** 退回輸入框,那個 Enter 永遠落不到提示上。(提示真的卡住時 cache 本來就無法保溫,等你回答後會自動恢復。)
115
+ - **與焦點/縮小無關**:注入是行程內部的 `pty.write`,跟視窗狀態無關。只有關閉視窗(結束 host 行程)才會停。
116
+
117
+ ### 設定
118
+
119
+ 環境變數(多為測試/進階用途):
120
+
121
+ | 變數 | 意義 |
122
+ |-----|------|
123
+ | `CWARM_MSG` | keepalive 訊息(預設 `hi`) |
124
+ | `CWARM_TICK_MS` | 檢查間隔(預設 `20000`) |
125
+ | `CWARM_QUIET_MS` | 畫面需靜止多久才注入(預設 `2500`) |
126
+ | `CWARM_ESC_DELAY_MS` | `Esc` 與訊息之間的間隔(預設 `250`) |
127
+ | `CWARM_THRESHOLD_S` | 覆寫閒置門檻(秒) |
128
+ | `CWARM_TTL_S` | 覆寫冷卻(秒) |
129
+ | `CWARM_CLAUDE` | `claude` 執行檔路徑(否則用 `which`/`where` 自動偵測) |
130
+ | `CLAUDE_CONFIG_DIR` | Claude 設定目錄(預設 `~/.claude`) |
131
+
132
+ ### 平台支援
133
+
134
+ - **Windows**(Git Bash/PowerShell/cmd/Windows Terminal):已驗證,含非 ASCII(中日韓)輸入。
135
+ - **Linux arm64/aarch64**:已在 Raspberry Pi 4(Debian、Node 22)驗證——全域安裝(node-pty 乾淨編譯)、`cwarm` 啟動、即時 keepalive 注入都確認可用。x64 預期相同。
136
+ - **macOS**:同樣的跨平台機制(node-pty + 你 shell 裡的 `claude`);預期可用,尚未實測,歡迎回報。
137
+
109
138
  ## Changelog
110
139
 
140
+ ### 0.1.7
141
+ - **Change:** `cwarm` no longer implicitly adds `--continue`. It is now a fully transparent pass‑through — `cwarm [args]` is exactly `claude [args]`, so bare `cwarm` starts a clean session. To resume your last session, run `cwarm --continue`. (Previously bare `cwarm` auto‑resumed.)
142
+ - **變更:** `cwarm` 不再隱含補上 `--continue`,改為完全透傳——`cwarm [參數]` 就等於 `claude [參數]`,所以單獨打 `cwarm` 會開全新 session。要接續上次請打 `cwarm --continue`。(先前單獨打 `cwarm` 會自動接續。)
143
+
144
+ ### 0.1.6
145
+ - **Docs:** every changelog entry now carries a Traditional Chinese version alongside the English. No code change.
146
+ - **文件:** 每條 changelog 現在都在英文旁附上繁體中文。無程式碼變動。
147
+
111
148
  ### 0.1.5
112
149
  - **Fix:** the keepalive could fire while Claude Code was showing a **mandatory prompt** (tool‑permission, `AskUserQuestion`, plan approval). Because the injected `hi␍` ends in Enter, that Enter landed on the prompt and selected its highlighted default — e.g. **auto‑approving a tool** — instead of sending a message (the reported "can't send `hi`"). Two layers fix it: **(1)** injection now waits for the PTY to be **quiet** (`CWARM_QUIET_MS`, default 2.5 s) — an animating prompt and a busy tool‑run both keep emitting output, so the keepalive no longer fires into either (this also stops it interrupting a long tool‑run, which the transcript‑mtime idle timer can't see); **(2)** the keepalive is now **`Esc`‑prefixed** (`CWARM_ESC_DELAY_MS` gap, default 250 ms) — it backs out of any prompt to the input box before sending `hi`, so the Enter can never select a menu default. Investigated empirically: a pending tool turn isn't written to the transcript while blocked (so transcript inspection can't detect this state), but the screen reliably distinguishes idle (silent) from prompt/busy (animating). While a prompt is genuinely blocking the cache can't be kept warm regardless; warming resumes once you answer.
150
+ - **修正:** keepalive 可能在 Claude Code 跳出**必答提示**(工具權限、`AskUserQuestion`、計畫批准)時觸發。因為注入的 `hi` 訊息以 Enter 結尾,那個 Enter 會落在提示上、選中反白的預設項——例如**自動核准某個工具**——而不是送出訊息(就是你回報的「送不出 `hi`」)。兩層修正:**(1)** 注入前先等 PTY **靜止**(`CWARM_QUIET_MS`,預設 2.5 秒)——提示在動、忙著跑工具/生成時都會持續輸出,所以 keepalive 不會再送進這兩種狀態(也順帶不會打斷長時間的工具執行,那是 transcript mtime 閒置計時看不到的);**(2)** keepalive 現在會**先送 `Esc`**(`CWARM_ESC_DELAY_MS` 間隔,預設 250 毫秒)——先退出任何提示、回到輸入框再送 `hi`,那個 Enter 就絕不會選到選單預設項。實測發現:卡住時那個 pending 的工具回合還沒被寫進 transcript(所以查 transcript 偵測不到這個狀態),但畫面能可靠分辨閒置(靜止)與提示/忙碌(在動)。提示真的卡住時 cache 本來就無法保溫;你回答後會自動恢復保溫。
113
151
 
114
152
  ### 0.1.4
115
153
  - **Fix:** the terminal could be left unusable after `/exit` or Ctrl‑C (keystrokes garbled / no usable input). The PTY host now restores the terminal on every exit path: it emits an explicit reset (disabling alt‑screen, bracketed‑paste, mouse, cursor‑hide, and — critically on Windows — `win32‑input‑mode` `?9001` and focus‑reporting `?1004`, which otherwise make the shell receive keystrokes as unparseable `ESC[…_` packets) and flushes stdout before exiting. Adds a `SIGINT` handler that forwards `0x03` to claude instead of letting the host be killed before cleanup, plus `SIGHUP`/`exit` safety restores.
154
+ - **修正:** `/exit` 或 Ctrl-C 之後終端可能變得不能用(鍵盤輸入亂碼/打不了字)。PTY host 現在會在每條退出路徑都還原終端:主動送出一段明確的重置序列(關掉 alt-screen、bracketed-paste、滑鼠、隱藏游標,以及——在 Windows 上最關鍵的——`win32-input-mode` `?9001` 與 focus-reporting `?1004`,否則 shell 會把每個鍵碼當成無法解析的 `ESC[…_` 封包收下),並在退出前把 stdout flush 掉。新增 `SIGINT` handler 把 `0x03` 轉送給 claude,而不是讓 host 在清理前就被殺掉;另加 `SIGHUP`/`exit` 的保險還原。
116
155
 
117
156
  ### 0.1.3
118
157
  - **Change:** the cache TTL is now **measured from the transcript** (`message.usage.cache_creation`'s `ephemeral_1h` / `ephemeral_5m` tokens) instead of being guessed from your subscription plan. A recent 1h write → 1h regime; only 5m writes (or no evidence) → 5m regime (conservative). This drops the `~/.claude/.credentials.json` read entirely and is correct even when a Pro account gets a 1h cache. Adds `transcriptPath` / `readTtlRegime` / `detectTtlRegime` / `regimeParams`; removes `detectPlan` / `planParams`.
158
+ - **變更:** cache TTL 現在**直接從 transcript 實測**(`message.usage.cache_creation` 裡的 `ephemeral_1h`/`ephemeral_5m` token),不再用你的訂閱方案去猜。最近有任一回合寫過 1h → 1h 檔位;只有 5m 寫入(或還沒有證據)→ 5m 檔位(保守)。這完全拿掉了對 `~/.claude/.credentials.json` 的讀取,連 Pro 帳號拿到 1h cache 的情況也判得對。新增 `transcriptPath`/`readTtlRegime`/`detectTtlRegime`/`regimeParams`;移除 `detectPlan`/`planParams`。
119
159
 
120
160
  ### 0.1.2
121
161
  - **Fix:** idle is now measured from the newest transcript file's mtime — i.e. time since your last *message* — instead of keystrokes. Scrolling, arrow‑key reading, or a half‑typed prompt no longer reset the idle timer, so the keepalive actually fires while you're reading and the cache stops going cold. Adds `encodeProjectDir` / `transcriptMtimeMs` / `transcriptIdleMs`.
162
+ - **修正:** 閒置現在改用最新 transcript 檔的 mtime 來計算——也就是距你上次*發訊息*多久——而不是看鍵盤輸入。捲動、用方向鍵讀回覆、或打到一半還沒送出,都不會再重置閒置計時,所以 keepalive 會在你閱讀時照常觸發、cache 不再冷掉。新增 `encodeProjectDir`/`transcriptMtimeMs`/`transcriptIdleMs`。
122
163
 
123
164
  ### 0.1.0
124
165
  - Initial release. (0.1.1 was a version‑only bump and was never published to npm.)
166
+ - **首次發佈。**(0.1.1 只是純版本號 bump,從未發佈到 npm。)
125
167
 
126
168
  ## License
127
169
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claude-cache-keepalive",
3
- "version": "0.1.5",
3
+ "version": "0.1.7",
4
4
  "description": "Keep Claude Code's prompt cache warm while idle, by running claude inside a PTY host and injecting a tiny keepalive when you step away. Cross-platform, no tmux required.",
5
5
  "type": "module",
6
6
  "bin": {
package/src/cli.mjs CHANGED
@@ -12,14 +12,16 @@ if (first === 'setup') {
12
12
  printHelp();
13
13
  process.exit(0);
14
14
  } else {
15
- startHost({ args: argv }); // 無參數時 host 內部預設 --continue
15
+ startHost({ args: argv }); // 完全透傳給 claude;不帶參數就是乾淨的 claude(不再隱含 --continue
16
16
  }
17
17
 
18
18
  function printHelp() {
19
19
  process.stdout.write(`cwarm — keep Claude Code's prompt cache warm while idle.
20
20
 
21
21
  Usage:
22
- cwarm [claude args...] Launch claude (default: --continue) inside the keepalive host.
22
+ cwarm [claude args...] Launch claude inside the keepalive host. Args pass straight
23
+ through, so \`cwarm\` === plain \`claude\`; use \`cwarm --continue\`
24
+ to resume your last session.
23
25
  cwarm setup Optionally install the cache-countdown statusline (opt-in).
24
26
  cwarm setup --remove Remove the statusline this tool installed.
25
27
  cwarm help Show this help.
package/src/host.mjs CHANGED
@@ -35,7 +35,9 @@ export function startHost(opts = {}) {
35
35
  const LOG = path.join(claudeDir, 'cwarm-keepalive.log');
36
36
  const DISABLE = path.join(claudeDir, 'cwarm.disabled');
37
37
 
38
- const args = opts.args && opts.args.length ? opts.args : ['--continue'];
38
+ // 完全透傳:cwarm [args] === claude [args]。不帶參數就是乾淨的 `claude`(全新 session);
39
+ // 要接續上次請自己打 `cwarm --continue`。不再隱含補 --continue。
40
+ const args = opts.args || [];
39
41
  const { file, args: spawnArgs } = spawnSpec(resolveClaude(), args);
40
42
 
41
43
  const ptyProc = pty.spawn(file, spawnArgs, {