@tduyng/pi-cost 0.0.2 → 0.0.4

package/README.md

@@ -1,45 +1,46 @@
 # @tduyng/pi-cost
 
-Cost tracking, rate-limit windows, statusline segments, and per-message timestamps for pi sessions.
+Session spend, live rate-limit windows, footer segments and per-message timestamps, read from files pi already wrote. None of it enters a request.
 
-## What it does
+Pi's footer prints a running total and not the split: no per-provider view over the month, no record of what a delegated child cost, no sight of the rate-limit window about to end the day.
 
-### /cost panel
+## The panel
 
-Type `/cost` and get a TUI panel with session USD spend, token totals, provider rate-limit bars, and a per-provider token table.
+`/cost` opens a TUI panel with session spend in USD, token totals, a per-provider token table, and the live rate-limit windows.
 
-The panel fits the window: its body takes at most 70% of the terminal rows, each line is truncated to the column width instead of wrapping, and the header line shows the range when the rest is scrollable. Up and down move one row, page up and page down move one screen, and Enter or Esc closes it.
+The panel fits the window it opens in: body at most 70% of the rows, each line truncated to the column width, the header naming the range when the rest scrolls. Up and Down move a row, Page Up and Page Down a screen, Enter or Esc closes.
 
-An `Extensions` row appears when an extension spent a model call on this session's behalf: a `subagent` child, or the `harness-loop` writer. Those calls bill to the same plan but cannot land in the parent's transcript, so each one appends a line to `<agentDir>/overhead.jsonl` and the panel sums the lines for this session. The row names the cost, the tokens, the call count and each extension's share. The `Cost` row stays what the conversation itself cost, so the two are read side by side and never added twice.
+The token table groups by provider across four trailing windows: 5h, 7d, 30d, calendar month. Input, output, cache read and cache write are separate, then the total and the cost. A zero column collapses to a dot, and a provider with no tokens is omitted.
 
-The rate-limit section covers three providers.
-Command Code shows the session 5h window, the weekly window, and remaining credits (monthly plus purchased plus free). Its section paints only when pi holds a Command Code credential in `auth.json`. Without one the probe returns nothing, the section drops, and its cached rows are deleted.
-OpenCode Go shows the rolling window, weekly, and monthly.
-Claude shows the 5h window and the weekly windows (all models, Opus, Sonnet) as percent bars. It reads the Claude Code login on this machine, and its section paints only when that login exists.
+| Provider | Windows shown |
+| --- | --- |
+| Command Code | session 5h, weekly, remaining credits |
+| OpenCode Go | rolling, weekly, monthly |
+| Claude | 5h, weekly all models, Opus, Sonnet, as percent bars |
 
-The token table groups rows by provider (alphabetically) across four trailing windows: 5h, 7d, 30d, and calendar month. Input, output, cache read, and cache write are shown separately, then the total and the cost. A zero column collapses to a dot. Providers with no tokens in any window are omitted. The cost is the `usage.cost.total` each turn recorded in its session file, so it is the API-equivalent price for subscription providers such as `claude`, not a charge.
+A section paints only when the credential it needs is on the machine. Without one the probe returns nothing and the section drops. Providers with no usage endpoint (opencode, mistral, gmi) appear in the token table only. Command Code stays out of the panel unless pi holds a credential for it in `auth.json`.
 
-### Footer segments
+Amounts under $0.01 print with four decimals, under $1 with three, and $1 or more with two. A model with no known pricing contributes zero, so the panel understates spend instead of guessing.
 
-Three extra segments appear in pi's native footer.
-`tps` shows average output tokens per second across the session.
-`agents` shows the count of running subagent tasks.
-`git` shows changed files and the PR number from `gh pr view`.
+## Where the numbers come from
 
-Session spend and the cache hit rate are left to pi's own footer, which prints both. They were `cost` and `cache` segments here until this version dropped them.
+Token totals come from scanning the session `.jsonl` files. Cost is the `usage.cost.total` each turn recorded, not a recomputation from a price table. For a subscription provider such as `claude` that is the API-equivalent price rather than a charge, and the panel says so.
 
-Use `/statusline` to toggle these segments on or off. Use `--statusline-no-pr` to skip the `gh pr view` lookup. The git segment refreshes when a run settles and on a debounced filesystem watcher on `.git/HEAD` (250ms delay), so a branch switch paints at once and an idle session spawns nothing. Worktrees that store `.git` as a file are covered by the settle refresh.
+Two caches keep it quick to open. `<agentDir>/cost-cache.json` stores parsed records keyed by file mtime and size, so a re-open skips unchanged files. Quota data is cached 24 hours, and files outside the scan window are skipped without a stat call.
 
-### /timestamps
+Work that bills to the same plan but cannot land in the transcript is recorded separately. A `subagent` child or the `harness-loop` writer appends a line to `<agentDir>/overhead.jsonl`, and the `Extensions` row sums them for this session with the call count and each extension's share. The `Cost` row stays what the conversation itself cost, so the two are read side by side and never added twice.
 
-Type `/timestamps` to toggle per-message clock markers in the transcript. Each marker shows the time of day, a relative offset (for example "3m ago"), and whether the message was a user message, AI response, or tool call. Markers are custom session entries, so they never enter model context and the cached prompt prefix stays stable. Two same-role entries within a 2-second window are detected as duplicates (from a double-loaded extension) and suppressed.
+## Footer and timestamps
 
-## How it works
+Three segments added to pi's native footer:
 
-- Token totals come from scanning session `.jsonl` files. A cache at `<agentDir>/cost-cache.json` stores parsed records keyed by file mtime and size, so repeated `/cost` opens skip unchanged files. Quota data is cached for 24 hours. Files older than the scan window are skipped without a stat call. The cost panel formats amounts under $0.01 with four decimal places, amounts under $1 with three, and amounts at $1 or above with two. Providers `gmi`, `mistral`, `google`, `claude-bridge`, and `commandcode` are excluded from the token table unless `cost.json` names them. A model with no known pricing contributes zero to the total, so the panel understates spend rather than guessing it.
-- Provider quota data is fetched from Command Code's billing/credits endpoint, OpenCode Go's usage endpoint, and Anthropic's OAuth usage endpoint.
-- Nothing enters the model's context. No tool is registered, no prompt text is injected, no session entry is created.
-- The extension adds no segment for session spend or the cache hit rate. It does not track spend across sessions (only the active branch).
+- `tps`: average output tokens per second across the session.
+- `agents`: running subagent tasks.
+- `git`: changed files and the PR number from `gh pr view`.
+
+Session spend and cache hit rate stay with pi's own footer, which already prints both. `/statusline` toggles the segments and `--statusline-no-pr` skips the `gh pr view` lookup. The git segment refreshes on settle and on a debounced watch of `.git/HEAD`, so a branch switch paints at once and an idle session spawns nothing.
+
+`/timestamps` toggles per-message clock markers: time of day, a relative offset such as `3m ago`, and whether the entry is a user message, an assistant reply or a tool call. Markers are custom session entries, so they never enter model context, and two same-role entries inside a 2-second window are read as a double-loaded extension and suppressed.
 
 ## Install
 
@@ -49,13 +50,15 @@ pi install npm:@tduyng/pi-cost
 
 Local checkout: `pi install /path/to/dotfiles/pi/agent/extensions/pi-cost`
 
-## Configure
+Optional:
 
-Environment variables:
+- `OPENCODE_API_KEY` for the OpenCode Go windows.
+- A Claude OAuth credential for the Claude windows, from the macOS keychain or `~/.claude/.credentials.json`.
+- `gh` on PATH for the PR segment.
 
-- `OPENCODE_API_KEY`: OpenCode Go API key.
+## Config
 
-`<agentDir>/cost.json` controls the token table and the rate-limit sections. It is read each time `/cost` opens, and an invalid file is ignored with a warning. All keys are optional:
+`<agentDir>/cost.json` controls the table and the sections. It is read each time `/cost` opens, and an invalid file is ignored with a warning. Every key is optional:
 
 ```json
 {
@@ -65,6 +68,12 @@ Environment variables:
 }
 ```
 
-- `providers`: the only providers shown in the token table. Omit it to show every provider except the excluded ones above.
-- `cost`: the providers whose cost cell is filled. Omit it to fill the cost for every shown provider. A provider not listed shows a blank cost cell.
-- `limits`: the rate-limit sections to show, by provider id (`commandcode`, `opencode-go`, `claude`). Omit it to show every section that has a credential. A section not listed is not fetched.
+- `providers` lists the providers in the token table. Omit it to show every provider except `gmi`, `mistral`, `google`, `claude-bridge` and `commandcode`, which are hidden unless named.
+- `cost` lists the providers whose cost cell is filled. Omit it to fill every shown provider.
+- `limits` lists the rate-limit sections to fetch. Omit it to show every section with a credential.
+
+## Limits
+
+- Network probes time out at 10 seconds and the keychain at 5, so a slow provider costs a pause.
+- Quota rows older than 24 hours are marked stale rather than deleted.
+- `cost-cache.json` is capped at 8 MB.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tduyng/pi-cost",
-  "version": "0.0.2",
-  "description": "Session spend, live provider rate-limit windows, footer segments, and per-message timestamps.",
+  "version": "0.0.4",
+  "description": "Session spend, live rate-limit windows, footer segments, and per-message timestamps. Display only, never in the model context.",
   "keywords": [
     "pi",
     "pi-package",