@tduyng/pi-cost 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,178 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+Use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 tduyng

package/README.md

@@ -1,3 +1,70 @@
-# Temporary Holding Version
+# @tduyng/pi-cost
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Cost tracking, rate-limit windows, statusline segments, and per-message timestamps for pi sessions.
+
+## What it does
+
+### /cost panel
+
+Type `/cost` and get a TUI panel with session USD spend, token totals, provider rate-limit bars, and a per-provider token table.
+
+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.
+
+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 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.
+
+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.
+
+### Footer segments
+
+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`.
+
+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.
+
+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.
+
+### /timestamps
+
+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.
+
+## How it works
+
+- 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).
+
+## Install
+
+```bash
+pi install npm:@tduyng/pi-cost
+```
+
+Local checkout: `pi install /path/to/dotfiles/pi/agent/extensions/pi-cost`
+
+## Configure
+
+Environment variables:
+
+- `OPENCODE_API_KEY`: OpenCode Go API key.
+
+`<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:
+
+```json
+{
+  "providers": ["claude", "opencode-go"],
+  "cost": ["claude"],
+  "limits": ["claude", "opencode-go"]
+}
+```
+
+- `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.

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@tduyng/pi-cost",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "Session spend, live provider rate-limit windows, footer segments, and per-message timestamps.",
+  "keywords": [
+    "pi",
+    "pi-package",
+    "pi-extension",
+    "pi-coding-agent",
+    "cost",
+    "statusline",
+    "usage",
+    "rate-limit"
+  ],
+  "homepage": "https://gitlab.com/tduyng/pi-agent/-/tree/main/extensions/pi-cost#readme",
+  "bugs": "https://gitlab.com/tduyng/pi-agent/-/issues",
+  "license": "Apache-2.0",
+  "author": "tduyng",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/tduyng/pi-agent.git",
+    "directory": "extensions/pi-cost"
+  },
+  "type": "module",
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "peerDependencies": {
+    "@earendil-works/pi-ai": "*",
+    "@earendil-works/pi-coding-agent": "*",
+    "@earendil-works/pi-tui": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "pi": {
+    "extensions": [
+      "./src/cost/index.ts",
+      "./src/statusline/index.ts",
+      "./src/timestamps/index.ts"
+    ]
+  },
+  "dependencies": {
+    "ata-validator": "^1.62.1"
+  }
+}

package/src/cost/config.ts

@@ -0,0 +1,46 @@
+import { getAgentDir } from '@earendil-works/pi-coding-agent'
+import { readFileSync } from 'node:fs'
+import { join } from 'node:path'
+import { Validator, type Infer } from 'ata-validator'
+import { t } from 'ata-validator/t'
+
+export const COST_CONFIG_FILE = 'cost.json'
+
+const ProviderList = t.array(t.string({ minLength: 1 }))
+
+const CostSettings = t.object({
+    providers: t.optional(ProviderList),
+    cost: t.optional(ProviderList),
+    limits: t.optional(ProviderList)
+})
+const isCostSettings = new Validator(CostSettings).isValidObject
+
+export type CostConfig = Infer<typeof CostSettings>
+
+export interface LoadedCostConfig {
+    config: CostConfig
+    problem?: string
+}
+
+export function costConfigPath(): string {
+    return join(getAgentDir(), COST_CONFIG_FILE)
+}
+
+export function loadCostConfig(path: string = costConfigPath()): LoadedCostConfig {
+    let raw: string
+    try {
+        raw = readFileSync(path, 'utf8')
+    } catch {
+        return { config: {} }
+    }
+    let parsed: unknown
+    try {
+        parsed = JSON.parse(raw)
+    } catch {
+        return { config: {}, problem: `${COST_CONFIG_FILE} is not valid JSON, using defaults` }
+    }
+    if (!isCostSettings(parsed)) {
+        return { config: {}, problem: `${COST_CONFIG_FILE} needs "providers", "cost" and "limits" as string arrays` }
+    }
+    return { config: parsed }
+}