@pi-unipi/footer 3.0.0-alpha.26 → 3.0.0-alpha.28

package/README.md

@@ -1,6 +1,6 @@
 # Footer
 
-Show live session stats and the state of every UniPi package at the bottom of the terminal.
+Frames the input box and shows live session stats at the bottom of the terminal.
 
 `@pi-unipi/footer` · part of [UniPi](../../README.md)
 
@@ -8,11 +8,10 @@ Show live session stats and the state of every UniPi package at the bottom of th
 
 ## What it does
 
-- Puts a frame around the input box. This is **glance mode**, and it is on by default.
-- Shows a stats line below the input. It shows turns, steps, model time and tool time. It also shows average time to first token (TTFT), tokens per second, compactions and cache hit rate.
+- Puts a frame around the input box (**the glance frame**, always on when the footer is enabled).
+- Shows a stats line below the input: input/output tokens, cost, average time to first token (TTFT), tokens per second, turns, steps, model and tool time, cache hit rate, and compactions.
 - Shows a line above the input with counts of background tasks: running, stopped, failed and done.
-- Shows a status line with segments from each package when glance mode is off. This is the **classic** footer.
-- Lets you select a preset, separator, icon style and color mode, and turn each segment on or off.
+- Adapts to the terminal: parts of the stats line drop by priority when the terminal is narrow, badges leave the frame titles before the branch or model truncate, and on very short terminals the stats and task lines hide.
 
 ## Quick start
 
@@ -36,35 +35,23 @@ The footer starts with the session. Open `/unipi:settings` → **Footer** to cha
 |---|---|
 | `/unipi:footer` | Turns the footer on or off. |
 | `/unipi:footer on` | Turns the footer on. |
-| `/unipi:footer off` | Turns the footer off. |
-| `/unipi:footer-help` | Shows each active segment with its icon, label and description. |
+| `/unipi:footer off` | Turns the footer off (plain pi editor). |
 
 ## The glance frame
 
-The glance frame has three parts:
+The frame has three parts:
 
-- **Top border.** The UNIPI brand, the long-horizon mode, the git branch, and the plan and permission mode. The brand shows a moving rainbow. The frame also shows the rainbow when the thinking level is `xhigh` or `max`.
+- **Top border.** The UNIPI brand, the long-horizon mode, the git branch, and the plan and permission mode. The brand shows a moving rainbow. The frame also shows the rainbow when the thinking level is `xhigh` or `max` (unless **Rainbow** is `brand-only`).
 - **Bottom border.** The workspace name, context use and window size, the model and the thinking level. With a [Fusion](../fusion/README.md) pair, it shows the lead and the sidekick. It also shows Kanboard claims.
 - **Stats line.** The line below the input. A part stays hidden until it has data. For example, compactions show only after the first compaction.
 
 The background-task line reads the [Background Tasks](../background-tasks/README.md) registry. It shows nothing when no task exists.
 
-Set **Glance mode** to off to get the classic status line.
+## Responsive behavior
 
-## Presets
-
-A preset selects the segments of the classic status line.
-
-| Preset | Segments |
-|---|---|
-| `default` | brand, mode, model, directory, git, context, compactions, tokens, TPS, cost, clock, duration |
-| `classic` | mode, model, API state, tool count, git, TPS, context, cost, compactions, memory, command, loop status, extensions |
-| `minimal` | mode, model, git, context, clock |
-| `compact` | mode, model, git, TPS, context, cost, clock, duration |
-| `full` | all groups, with a second row |
-| `ascii` | the same segments as `compact` |
-
-The hub list also shows `dense`, `devops` and `zen`. These names have no preset definition, so the footer uses `default` for them. To select `compact`, `full` or `ascii`, edit the settings file.
+- **Width.** Each stats-line part has a priority. When the line does not fit, the lowest-priority parts drop whole (never mid-part), in this order: compactions, cache, time, turns, speed, cost — tokens always survive. The frame titles degrade the same way: the Kanboard label, the Fusion pair, the plan/permission cluster and the mode label drop (lowest value first) before the branch or model ever truncate.
+- **Width safety.** Nothing ever writes the last terminal column (a full-width line desyncs wrapping terminals).
+- **Height.** Below 20 terminal rows the stats line and the background-task line hide; the frame stays.
 
 ## Settings
 
@@ -72,33 +59,32 @@ Open `/unipi:settings` → **Footer**. The file is `~/.unipi/config/footer/confi
 
 | Key | Default | What it does |
 |---|---|---|
-| `enabled` | `true` | Turns the footer on or off. |
-| `glanceMode` | `true` | Uses the glance frame around the input. |
-| `preset` | `default` | Selects the segments of the classic status line. |
-| `showFullLabels` | `false` | Shows full labels in place of short labels. |
-| `separator` | `powerline-thin` | Segment divider: `powerline`, `powerline-thin`, `slash`, `pipe`, `dot`, `ascii`. |
-| `zoneSeparator` | `│` | Divider between the left, center and right zones. |
+| `enabled` | `true` | Turns the footer on or off. `false` leaves the plain pi editor. |
 | `iconStyle` | `nerd` | Icon set: `nerd` (needs a Nerd Font), `emoji` or `text`. |
-| `colorMode` | `auto` | `auto`, `truecolor`, `256` or `none`. |
-| `groups.<group>.show` | `true` (`notify`: `false`) | Shows or hides a segment group. |
-| `groups.<group>.segments.<id>` | per segment | Shows or hides one segment. |
-
-`colorMode: auto` uses 24-bit color where the terminal supports it. It uses 256 colors in terminals such as Apple Terminal. It uses no color when the `NO_COLOR` environment variable exists.
-
-The hub **Color mode** list shows `mono`. The footer does not know this value and uses `auto`. Use `none` in the file to turn off color.
-
-For the full list of segments and icons, refer to [Footer customization](../../FOOTER_CUSTOMIZATION.md).
+| `colorMode` | `auto` | `auto`, `truecolor`, `256` or `none`. The legacy value `mono` loads as `none`. |
+| `rainbow` | `always` | `always` animates the brand (and the whole frame at `xhigh`/`max` thinking); `brand-only` never animates the whole frame; `off` disables the animation. |
+| `processLine` | `true` | Shows the background-task line above the input. |
+| `strip.turns` | `true` | Turn and step counters. |
+| `strip.time` | `true` | Model time and tool time. |
+| `strip.speed` | `true` | Average TTFT and tokens per second. |
+| `strip.tokens` | `true` | Session input and output tokens. |
+| `strip.cost` | `true` | Session cost, or `sub` when the model runs on a subscription. |
+| `strip.compactions` | `true` | Compaction count, sizes and recency. |
+| `strip.cache` | `true` | Cache hit percentage. |
+| `badges.mode` | `true` | Long-horizon mode label beside the brand. |
+| `badges.planPermission` | `true` | PLAN badge and permission mode in the top border. |
+| `badges.fusion` | `true` | Fusion lead and sidekick in the bottom border. |
+| `badges.kanboard` | `true` | Kanboard claims label in the top border. |
+
+`colorMode: auto` uses 24-bit color where the terminal supports it, 256 colors in terminals such as Apple Terminal, and no color when the `NO_COLOR` environment variable exists.
+
+Old v2 keys (`preset`, `separator`, `zoneSeparator`, `showFullLabels`, `groups`, `glanceMode`) in existing config files are ignored.
 
 ## How it works
 
-The footer listens to UniPi events on the [event bus](../../docs/architecture/event-bus.md). Examples are `MEMORY_STORED`, `MCP_SERVER_STARTED`, `RALPH_LOOP_START`, `WORKFLOW_START`, `COMPACTOR_COMPACTED` and `NOTIFICATION_SENT`. It keeps the last data of each event. Thus a package that loads after the footer still shows its data.
-
-Some segments read data directly: the Pi session, the Kanboard registry and the Info Screen cache. The footer draws again each second.
-
-The classic status line puts segments that do not fit into a second row.
+The footer listens to UniPi events on the [event bus](../../docs/architecture/event-bus.md) for mode, plan and permission state. Usage data comes from an incremental scan of the session branch: each second only new entries are processed (a compaction or branch change triggers a full rescan), the same pass filling a cached snapshot for the stats line. The TPS tracker is fed live by pi's streaming events and reconciled by the same scan. The footer redraws when something it displays changed — plus once a second while the rainbow animates.
 
 ## See also
 
-- [Footer customization](../../FOOTER_CUSTOMIZATION.md)
 - [Info Screen](../info-screen/README.md)
 - [Settings reference](../../docs/reference/settings.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-unipi/footer",
-  "version": "3.0.0-alpha.26",
+  "version": "3.0.0-alpha.28",
   "description": "Persistent status bar for Unipi — subscribes to UNIPI_EVENTS and renders key stats from all unipi packages",
   "type": "module",
   "main": "index.ts",
@@ -32,8 +32,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@pi-unipi/core": "3.0.0-alpha.26",
-    "@pi-unipi/background-tasks": "3.0.0-alpha.26"
+    "@pi-unipi/core": "3.0.0-alpha.28",
+    "@pi-unipi/background-tasks": "3.0.0-alpha.28"
   },
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": "^0.87.1",

package/src/commands.ts

@@ -1,15 +1,14 @@
 /**
  * @pi-unipi/footer — Commands
  *
- * Footer commands: /unipi:footer (toggle) and /unipi:footer <preset>.
+ * /unipi:footer — toggle the footer on/off.
  */
 
 import type { ExtensionAPI, ExtensionContext } from "@earendil-works/pi-coding-agent";
 import { UNIPI_PREFIX, FOOTER_COMMANDS } from "@pi-unipi/core";
-import { loadFooterSettings, saveFooterSettings } from "./config.js";
-import { showFooterHelp } from "./help.js";
-import type { FooterSegment } from "./types.js";
-import { applyGlanceMode, type FooterState } from "./index.js";
+import { saveFooterSettings } from "./config.js";
+import type { FooterState } from "./index.js";
+import { fullRescan } from "./index.js";
 
 /**
  * Register footer commands.
@@ -21,34 +20,17 @@ export function registerCommands(pi: ExtensionAPI, state: FooterState): void {
     handler: async (args, ctx) => {
       const arg = args?.trim().toLowerCase();
 
-      // on
-      if (arg === "on") {
-        state.enabled = true;
-        state.renderer.setActive(true);
-        saveFooterSettings({ enabled: true });
-        state.setupUI?.(pi, ctx);
-        ctx.ui.notify("Footer enabled", "info");
-        return;
-      }
+      let enable: boolean;
+      if (arg === "on") enable = true;
+      else if (arg === "off") enable = false;
+      else enable = !state.enabled;
 
-      // off
-      if (arg === "off") {
-        state.enabled = false;
-        state.renderer.setActive(false);
-        ctx.ui.setFooter(undefined);
-        ctx.ui.setWidget("footer-top", undefined);
-        ctx.ui.setWidget("footer-secondary", undefined);
-        saveFooterSettings({ enabled: false });
-        ctx.ui.notify("Footer disabled", "info");
-        return;
-      }
-
-      // Toggle (no args or unknown args)
-      state.enabled = !state.enabled;
-      state.renderer.setActive(state.enabled);
+      state.enabled = enable;
+      saveFooterSettings({ enabled: enable });
 
-      if (state.enabled) {
+      if (enable) {
         state.setupUI?.(pi, ctx);
+        fullRescan(state);
         ctx.ui.notify("Footer enabled", "info");
       } else {
         ctx.ui.setFooter(undefined);
@@ -56,17 +38,6 @@ export function registerCommands(pi: ExtensionAPI, state: FooterState): void {
         ctx.ui.setWidget("footer-secondary", undefined);
         ctx.ui.notify("Footer disabled", "info");
       }
-
-      saveFooterSettings({ enabled: state.enabled });
-    },
-  });
-
-  // /unipi:footer-help — show help overlay
-  pi.registerCommand(`${UNIPI_PREFIX}${FOOTER_COMMANDS.FOOTER_HELP}`, {
-    description: "Show footer segment guide (icons, labels, descriptions)",
-    handler: async (_args, _ctx) => {
-      const allSegments = Array.from(state.segmentLookup.values());
-      showFooterHelp(pi, allSegments, state.renderer.getPresetName());
     },
   });
 }