pi-minimal-footer 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-15
+
+First npm-ready release.
+
+### Added
+
+- Minimal footer extension for pi — replaces the default footer with a clean, compact status line
+- **Working directory** segment — shows relative path from home (`~/...`)
+- **Active skills** segment — shows extension statuses
+- **Git branch** segment — current branch with Nerd Fonts icon (``)
+- **Model** segment — active model ID
+- **Context usage** segment — tokens used / context window (e.g. `12/128k`)
+- **Configuration** — all segments individually toggleable via `~/.pi/agent/settings.json`
+- **`/minfooter` command** — toggle the extension on/off from chat
+- MIT License
+
+### Changed
+
+- Context usage display deduplicates `k`/`M` suffix — shows `4/200k` instead of `4k/200k`
+- Context usage format removes spaces around `/` separator
+- README updated with Nerd Fonts git icon and npm install instructions
+- Package metadata expanded for npm release (`author`, `files`, `engines`, `keywords`, `homepage`, `bugs`)
+
+## [0.0.0] - 2026-06-13
+
+### Added
+
+- Project scaffold — `extensions/index.ts` with basic footer structure, `package.json` with pi extension manifest, `README.md`, `LICENSE` (MIT)
+
+[Unreleased]: https://github.com/Ryu-CZ/pi-minimal-footer/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/Ryu-CZ/pi-minimal-footer/compare/v0.0.0...v0.1.0
+[0.0.0]: https://github.com/Ryu-CZ/pi-minimal-footer/releases/tag/v0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ryu-CZ
+
+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

@@ -0,0 +1,60 @@
+# pi-minimal-footer
+
+A minimal footer extension for [pi](https://github.com/earendil-works/pi-coding-agent) that replaces the default footer with a clean, compact status line:
+
+```
+~/path/to/dir                (skill1 | skill2)   main  sonnet  12/128k
+```
+
+## Install
+
+```bash
+# From npm (recommended)
+pi install npm:pi-minimal-footer
+
+# From git
+pi install git:github.com/Ryu-CZ/pi-minimal-footer
+
+# Manual — copy into your extensions directory
+cp -r extensions/* ~/.pi/agent/extensions/
+
+# Development — symlink for live edits
+ln -s "$PWD/extensions" ~/.pi/agent/extensions/minimal-footer
+```
+
+## Features
+
+- **Working directory** — relative path from home (`~/...`)
+- **Active skills** — extension statuses from `ctx.ui.setStatus()`
+- **Git branch** — current branch name
+- **Model** — active model ID
+- **Context usage** — tokens used / context window (e.g. `12/128k`)
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `/minfooter` | Toggle the extension on/off |
+| `/minfooter on` | Enable |
+| `/minfooter off` | Disable |
+
+> The `/minfooter` command only controls the `enabled` setting. To tweak individual segments (path, model, etc.), edit `~/.pi/agent/settings.json` directly.
+
+## Configuration
+
+Settings are persisted in `~/.pi/agent/settings.json` under the `minFooter` key:
+
+```json
+{
+  "minFooter": {
+    "enabled": true,
+    "showGitBranch": true,
+    "showSkills": true,
+    "showPath": true,
+    "showModel": true,
+    "showContext": true
+  }
+}
+```
+
+Edit the file directly to show or hide individual segments. The `/minfooter` command is a shortcut that toggles only the `enabled` flag.

package/extensions/index.ts

@@ -0,0 +1,226 @@
+/**
+ * Minimal footer — replaces pi's default footer with a clean status line:
+ *
+ *   ~/path/to/dir                (skill1 | skill2)   main  sonnet  12k / 128k
+ *
+ * Settings are persisted in ~/.pi/agent/settings.json under "minFooter".
+ *
+ * Commands:
+ *   /minfooter          — toggle on/off
+ *   /minfooter on|off   — force state
+ */
+
+import type { ExtensionAPI, ExtensionContext, ReadonlyFooterDataProvider } from "@earendil-works/pi-coding-agent";
+import { visibleWidth } from "@earendil-works/pi-tui";
+import { readFileSync, writeFileSync, existsSync, mkdirSync } from "node:fs";
+import { join, dirname } from "node:path";
+import { homedir } from "node:os";
+
+// ── Settings ──────────────────────────────────────────────────────────
+
+interface Settings {
+  minFooter?: {
+    enabled?: boolean;
+    showGitBranch?: boolean;
+    showSkills?: boolean;
+    showPath?: boolean;
+    showModel?: boolean;
+    showContext?: boolean;
+  };
+}
+
+const DEFAULT_SETTINGS: Settings["minFooter"] = {
+  enabled: true,
+  showGitBranch: true,
+  showSkills: true,
+  showPath: true,
+  showModel: true,
+  showContext: true,
+};
+
+function settingsPath(): string {
+  return join(homedir(), ".pi", "agent", "settings.json");
+}
+
+function readSettings(): Settings {
+  try {
+    if (!existsSync(settingsPath())) return {};
+    return JSON.parse(readFileSync(settingsPath(), "utf-8")) as Settings;
+  } catch {
+    return {};
+  }
+}
+
+function writeSettings(patch: Partial<Settings>): void {
+  try {
+    const path = settingsPath();
+    mkdirSync(dirname(path), { recursive: true });
+    const current = readSettings();
+    writeFileSync(path, JSON.stringify({ ...current, ...patch }, null, 2) + "\n");
+  } catch {
+    // best-effort
+  }
+}
+
+function readEnabled(): boolean {
+  const s = readSettings();
+  return s.minFooter?.enabled !== false; // default to true
+}
+
+function readConfig(): Settings["minFooter"] {
+  const s = readSettings();
+  return { ...DEFAULT_SETTINGS, ...s.minFooter };
+}
+
+function writeEnabled(v: boolean): void {
+  const cfg = readConfig();
+  cfg.enabled = v;
+  writeSettings({ minFooter: cfg });
+}
+
+// ── Formatting helpers ────────────────────────────────────────────────
+
+function formatSize(n: number | null | undefined): string {
+  if (n == null) return "?";
+  if (n >= 1_000_000) return `${Math.round(n / 1_000_000)}M`;
+  if (n >= 1_000) return `${Math.round(n / 1_000)}k`;
+  return String(n);
+}
+
+// ── State ─────────────────────────────────────────────────────────────
+
+let enabled = readEnabled();
+let config = readConfig();
+let state = {
+  cwd: process.cwd(),
+  model: "no-model",
+  context: "?",
+  branch: "",
+  footerData: null as ReadonlyFooterDataProvider | null,
+};
+
+function updateState(ctx: ExtensionContext): void {
+  state.cwd = ctx.cwd ?? process.cwd();
+  state.model = ctx.model?.id ?? "no-model";
+  const usage = ctx.getContextUsage();
+  if (usage) {
+    const fTokens = formatSize(usage.tokens);
+    const fWindow = formatSize(usage.contextWindow);
+    const lastT = fTokens[fTokens.length - 1];
+    const lastW = fWindow[fWindow.length - 1];
+    // Deduplicate k/M suffix: show suffix only on denominator when both use the same unit
+    if ((lastT === "k" || lastT === "M") && lastT === lastW) {
+      state.context = `${fTokens.slice(0, -1)}/${fWindow}`;
+    } else {
+      state.context = `${fTokens}/${fWindow}`;
+    }
+  } else {
+    state.context = "?";
+  }
+}
+
+// ── Footer builders ───────────────────────────────────────────────────
+
+function buildLeft(): string {
+  if (!config.showPath) return "";
+  const home = homedir();
+  if (state.cwd.startsWith(home)) {
+    return "~" + state.cwd.slice(home.length);
+  }
+  return state.cwd;
+}
+
+function buildRight(footerData: ReadonlyFooterDataProvider): string {
+  const segments: string[] = [];
+
+  if (config.showSkills) {
+    const statuses = footerData.getExtensionStatuses();
+    if (statuses.size > 0) {
+      segments.push("(" + [...statuses.values()].join(" | ") + ")");
+    }
+  }
+
+  if (config.showGitBranch) {
+    const branch = footerData.getGitBranch();
+    if (branch) segments.push(` ${branch}`);
+  }
+
+  if (config.showModel) {
+    segments.push(state.model);
+  }
+
+  if (config.showContext) {
+    segments.push(state.context);
+  }
+
+  return segments.join("  ");
+}
+
+// ── Extension ─────────────────────────────────────────────────────────
+
+export default function (pi: ExtensionAPI) {
+  function setFooter(ctx: ExtensionContext): void {
+    updateState(ctx);
+    config = readConfig(); // re-read on each set
+
+    if (!ctx.hasUI) return;
+
+    if (enabled) {
+      ctx.ui.setFooter((tui, theme, footerData) => {
+        state.footerData = footerData;
+
+        const unsub = footerData.onBranchChange(() => tui.requestRender());
+
+        return {
+          render(width: number): string[] {
+            const left = buildLeft();
+            const right = buildRight(footerData);
+            const leftW = visibleWidth(left);
+            const rightW = visibleWidth(right);
+            const gap = Math.max(1, width - leftW - rightW);
+            const spacer = " ".repeat(gap);
+            const line = theme.fg("dim", `${left}${spacer}${right}`);
+            return [line];
+          },
+          invalidate(): void {},
+          dispose: unsub,
+        };
+      });
+    } else {
+      ctx.ui.setFooter(undefined);
+    }
+  }
+
+  // ── Lifecycle events ────────────────────────────────────────────────
+
+  pi.on("session_start", async (_event, ctx) => {
+    enabled = readEnabled();
+    setFooter(ctx);
+  });
+
+  pi.on("model_select", async (_event, ctx) => {
+    setFooter(ctx);
+  });
+
+  pi.on("message_end", async (_event, ctx) => {
+    setFooter(ctx);
+  });
+
+  pi.on("session_compact", async (_event, ctx) => {
+    setFooter(ctx);
+  });
+
+  // ── Command ─────────────────────────────────────────────────────────
+
+  pi.registerCommand("minfooter", {
+    description: "Toggle minimal footer",
+    handler: async (args, ctx) => {
+      if (args === "on") enabled = true;
+      else if (args === "off") enabled = false;
+      else enabled = !enabled;
+      writeEnabled(enabled);
+      setFooter(ctx);
+      ctx.ui.notify(`Minimal footer ${enabled ? "enabled" : "disabled"}`, "info");
+    },
+  });
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "pi-minimal-footer",
+  "version": "0.1.0",
+  "description": "A minimal footer extension for pi — clean status line with path, skills, model, and context usage.",
+  "keywords": ["pi-package", "pi-extension", "pi", "footer", "minimal"],
+  "homepage": "https://github.com/Ryu-CZ/pi-minimal-footer#readme",
+  "bugs": {
+    "url": "https://github.com/Ryu-CZ/pi-minimal-footer/issues"
+  },
+  "license": "MIT",
+  "author": "Ryu-CZ <thandeus@gmail.com> (https://github.com/Ryu-CZ)",
+  "files": [
+    "CHANGELOG.md",
+    "extensions/",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ryu-CZ/pi-minimal-footer.git"
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "*",
+    "@earendil-works/pi-tui": "*"
+  },
+  "pi": {
+    "extensions": ["./extensions"]
+  }
+}