@ravshansbox/pi-statusline 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ravshan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,27 @@
-# Temporary Holding Version
+# pi-statusline
 
-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.
+Statusline extension for pi.
+
+## Install
+
+```bash
+pi install npm:@ravshansbox/pi-statusline
+```
+
+Add `-l` to install it in project settings.
+
+## Usage
+
+Pi loads the extension from `./index.ts`. It replaces the built-in footer with a statusline that shows:
+
+- the working directory, git branch and session name
+- token usage, cache hit rate, cost and context usage
+- the provider, model and thinking level
+- statuses set by other extensions
+
+## Development
+
+```bash
+npm install
+npm run check
+```

package/index.ts

@@ -0,0 +1,180 @@
+import { isAbsolute, relative, resolve, sep } from 'node:path';
+import {
+  type ExtensionAPI,
+  type ExtensionContext,
+  SettingsManager,
+} from '@earendil-works/pi-coding-agent';
+import { truncateToWidth, visibleWidth } from '@earendil-works/pi-tui';
+
+type Usage = {
+  input: number;
+  output: number;
+  cacheRead: number;
+  cacheWrite: number;
+  cost: { total: number };
+};
+
+function sanitizeStatusText(text: string): string {
+  return text
+    .replace(/[\r\n\t]/g, ' ')
+    .replace(/ +/g, ' ')
+    .trim();
+}
+
+function formatTokens(count: number): string {
+  if (count < 1000) return count.toString();
+  if (count < 10000) return `${(count / 1000).toFixed(1)}k`;
+  if (count < 1000000) return `${Math.round(count / 1000)}k`;
+  if (count < 10000000) return `${(count / 1000000).toFixed(1)}M`;
+  return `${Math.round(count / 1000000)}M`;
+}
+
+function formatCwd(cwd: string, home: string | undefined): string {
+  if (!home) return cwd;
+  const rel = relative(resolve(home), resolve(cwd));
+  const inside = rel === '' || (rel !== '..' && !rel.startsWith(`..${sep}`) && !isAbsolute(rel));
+  if (!inside) return cwd;
+  return rel === '' ? '~' : `~${sep}${rel}`;
+}
+
+function getUsage(ctx: ExtensionContext) {
+  const totals = { input: 0, output: 0, cacheRead: 0, cacheWrite: 0, cost: 0 };
+  let latestCacheHitRate: number | undefined;
+  const add = (u: Usage) => {
+    totals.input += u.input;
+    totals.output += u.output;
+    totals.cacheRead += u.cacheRead;
+    totals.cacheWrite += u.cacheWrite;
+    totals.cost += u.cost.total;
+  };
+  for (const entry of ctx.sessionManager.getEntries()) {
+    if (entry.type === 'usage') {
+      add(entry.usage);
+    } else if (entry.type === 'message' && entry.message.role === 'assistant') {
+      const u = entry.message.usage;
+      add(u);
+      const prompt = u.input + u.cacheRead + u.cacheWrite;
+      latestCacheHitRate = prompt > 0 ? (u.cacheRead / prompt) * 100 : undefined;
+    } else if (
+      entry.type === 'message' &&
+      entry.message.role === 'toolResult' &&
+      entry.message.usage
+    ) {
+      add(entry.message.usage);
+    } else if ((entry.type === 'branch_summary' || entry.type === 'compaction') && entry.usage) {
+      add(entry.usage);
+    }
+  }
+  return { totals, latestCacheHitRate };
+}
+
+export default function (pi: ExtensionAPI) {
+  pi.on('session_start', (_event, ctx) => {
+    if (ctx.mode !== 'tui') return;
+    const settings = SettingsManager.create(ctx.cwd);
+
+    ctx.ui.setFooter((tui, theme, footerData) => {
+      const unsub = footerData.onBranchChange(() => tui.requestRender());
+      return {
+        dispose: unsub,
+        invalidate() {},
+        render(width: number): string[] {
+          const model = ctx.model;
+          const { totals, latestCacheHitRate } = getUsage(ctx);
+          const contextUsage = ctx.getContextUsage();
+          const contextWindow = contextUsage?.contextWindow ?? model?.contextWindow ?? 0;
+          const contextPercentValue = contextUsage?.percent ?? 0;
+          const contextPercent =
+            contextUsage?.percent != null ? contextPercentValue.toFixed(1) : '?';
+
+          let pwd = formatCwd(
+            ctx.sessionManager.getCwd(),
+            process.env['HOME'] || process.env['USERPROFILE'],
+          );
+          const branch = footerData.getGitBranch();
+          if (branch) pwd = `${pwd} (${branch})`;
+          const sessionName = ctx.sessionManager.getSessionName();
+          if (sessionName) pwd = `${pwd} • ${sessionName}`;
+
+          const statsParts: string[] = [];
+          if (totals.input) statsParts.push(`↑${formatTokens(totals.input)}`);
+          if (totals.output) statsParts.push(`↓${formatTokens(totals.output)}`);
+          if (totals.cacheRead) statsParts.push(`R${formatTokens(totals.cacheRead)}`);
+          if (totals.cacheWrite) statsParts.push(`W${formatTokens(totals.cacheWrite)}`);
+          if ((totals.cacheRead > 0 || totals.cacheWrite > 0) && latestCacheHitRate !== undefined) {
+            statsParts.push(`CH${latestCacheHitRate.toFixed(1)}%`);
+          }
+
+          const usingSubscription = model
+            ? model.provider === 'kimi-coding' ||
+              (ctx.modelRegistry.isUsingOAuth(model) &&
+                ctx.modelRegistry.getProvider(model.provider)?.auth.oauth?.isSubscription === true)
+            : false;
+          if (totals.cost || usingSubscription) {
+            statsParts.push(`$${totals.cost.toFixed(3)}${usingSubscription ? ' (sub)' : ''}`);
+          }
+
+          const autoIndicator = settings.getCompactionEnabled() ? ' (auto)' : '';
+          const contextDisplay =
+            contextPercent === '?'
+              ? `?/${formatTokens(contextWindow)}${autoIndicator}`
+              : `${contextPercent}%/${formatTokens(contextWindow)}${autoIndicator}`;
+          if (contextPercentValue > 90) statsParts.push(theme.fg('error', contextDisplay));
+          else if (contextPercentValue > 70) statsParts.push(theme.fg('warning', contextDisplay));
+          else statsParts.push(contextDisplay);
+
+          if (process.env['PI_EXPERIMENTAL'] === '1') {
+            statsParts.push(`${theme.fg('dim', '•')} ${theme.bold(theme.fg('warning', 'xp'))}`);
+          }
+
+          let statsLeft = statsParts.join(' ');
+          let statsLeftWidth = visibleWidth(statsLeft);
+          if (statsLeftWidth > width) {
+            statsLeft = truncateToWidth(statsLeft, width, '...');
+            statsLeftWidth = visibleWidth(statsLeft);
+          }
+
+          const minPadding = 2;
+          const modelName = model?.id || 'no-model';
+          let right = modelName;
+          if (model?.reasoning) {
+            const level = ctx.thinkingLevel || 'off';
+            right = level === 'off' ? `${modelName} • thinking off` : `${modelName} • ${level}`;
+          }
+
+          const rightWidth = visibleWidth(right);
+          let statsLine: string;
+          if (statsLeftWidth + minPadding + rightWidth <= width) {
+            statsLine = statsLeft + ' '.repeat(width - statsLeftWidth - rightWidth) + right;
+          } else {
+            const available = width - statsLeftWidth - minPadding;
+            if (available > 0) {
+              const truncatedRight = truncateToWidth(right, available, '');
+              const padding = ' '.repeat(
+                Math.max(0, width - statsLeftWidth - visibleWidth(truncatedRight)),
+              );
+              statsLine = statsLeft + padding + truncatedRight;
+            } else {
+              statsLine = statsLeft;
+            }
+          }
+
+          const remainder = statsLine.slice(statsLeft.length);
+          const pwdLine = truncateToWidth(theme.fg('dim', pwd), width, theme.fg('dim', '...'));
+          const lines = [pwdLine, theme.fg('dim', statsLeft) + theme.fg('dim', remainder)];
+
+          const statuses = footerData.getExtensionStatuses();
+          if (statuses.size > 0) {
+            const line = Array.from(statuses.entries())
+              .sort(([a], [b]) => a.localeCompare(b))
+              .map(([, text]) => sanitizeStatusText(text))
+              .join(' ');
+            lines.push(truncateToWidth(line, width, theme.fg('dim', '...')));
+          }
+
+          return lines;
+        },
+      };
+    });
+  });
+}

package/package.json

@@ -1,6 +1,50 @@
 {
   "name": "@ravshansbox/pi-statusline",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.0",
+  "description": "Statusline extension for pi",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ravshansbox/pi-statusline.git"
+  },
+  "homepage": "https://github.com/ravshansbox/pi-statusline#readme",
+  "bugs": {
+    "url": "https://github.com/ravshansbox/pi-statusline/issues"
+  },
+  "keywords": [
+    "pi-package",
+    "pi-extension",
+    "statusline"
+  ],
+  "pi": {
+    "extensions": [
+      "./index.ts"
+    ]
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint --deny-warnings",
+    "lint:fix": "oxlint --fix",
+    "format": "oxfmt",
+    "format:check": "oxfmt --check",
+    "test": "node --test",
+    "check": "npm run typecheck && npm run lint && npm run format:check && npm test"
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "*",
+    "@earendil-works/pi-tui": "*"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.5",
+    "oxfmt": "^0.74.0",
+    "oxlint": "^1.89.0",
+    "typescript": "^7.0.2"
+  },
+  "files": [
+    "index.ts"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}