✨ pi-fancy-footer

A pi extension that replaces the default footer with a compact, two-line fancy status footer.

🚀 Installation

pi install npm:pi-fancy-footer

📊 What it shows

• Active model + thinking level
• Provider quota status for OpenAI Codex
• Context window capacity and a mini gauge of remaining context
• Total session cost
• Repo / path, branch, commit, open PR number, unresolved PR review threads, and PR CI status
• Git diff stats and ahead/behind status

📸 Screenshots

[!NOTE] Some screenshots include pi-banner, which is now a separate extension.

🎮 Commands

• /fancy-footer - open interactive footer config editor (small TUI)
  • settings are grouped into General, Built-in widgets, and Extension widgets sections
  • built-in and 3rd-party widgets are listed directly (with icon prefixes)
  • select a widget and press Enter for detailed settings
  • in widget settings, adjust row/position/align/fill/min-width, visibility, icon hide, icon color, and text color
  • use Enter/Space to cycle values

⚙️ Configuration

Create ~/.pi/agent/fancy-footer.json:

{
  "refreshMs": 3000,
  "iconFamily": "unicode",
  "gaugeStyle": "blocks",
  "gaugeWidth": 5,
  "gaugeColors": {
    "ok": "accent",
    "warning": "warning",
    "error": "error"
  },
  "defaultTextColor": "dim",
  "defaultIconColor": "text",
  "providerStatus": {
    "refreshMs": 60000,
    "cacheTtlMs": 60000,
    "providers": ["openai-codex"],
    "display": "gauge",
    "showCredits": false,
    "showReset": false
  },
  "widgets": {
    "context-bar": {
      "align": "left",
      "row": 0,
      "position": 0
    },
    "total-cost": {
      "enabled": false
    },
    "branch": {
      "icon": "hide",
      "textColor": "muted"
    }
  },
  "extensionWidgets": {
    "acme.build-status": {
      "row": 1,
      "position": 8,
      "align": "right"
    }
  }
}

Top-level settings:

[!NOTE] fancy-footer.json is validated strictly. Use only the documented keys and values. Invalid config falls back to defaults and logs a warning.

• refreshMs (number)
• iconFamily (nerd | emoji | unicode | ascii)
• gaugeStyle (blocks | lines | circles | parallelograms | diamonds | bars | stars | specks)
• gaugeWidth - cells spanned by the context and provider status gauges (3-40, default 5)
• gaugeColors - fill colors per gauge severity; each of ok, warning, and error accepts a widget color. Defaults to accent / warning / error, so healthy gauges blend into the theme and only stand out when running low
• defaultTextColor (text | accent | muted | dim | success | error | warning)
• defaultIconColor (text | accent | muted | dim | success | error | warning)
• providerStatus:
  • refreshMs - provider status refresh interval in milliseconds
  • cacheTtlMs - cache freshness window in milliseconds
  • providers - supported provider adapters (openai-codex)
  • display - render quota windows as a mini gauge (default) or plain text
  • showCredits - include provider-specific credit balance when available
  • showReset - include the primary reset time when available

Supported per-widget overrides for both widgets and extensionWidgets:

• enabled (boolean)
• row (number)
• position (number, ordering within an aligned row group)
• align (left | middle | right)
• fill (none | grow)
• minWidth (number)
• icon (default | hide)
• iconColor (text | accent | muted | dim | success | error | warning)
• textColor (text | accent | muted | dim | success | error | warning)

Built-in widget IDs:

• model
• thinking
• context-capacity
• context-bar
• total-cost
• location
• branch
• commit
• pull-request
• pull-request-review-threads
• pull-request-ci-status
• provider-status
• diff-added
• diff-removed
• git-status

3rd-party widget IDs are extension-defined and live under extensionWidgets.

🧩 Extension widgets

Other pi extensions can contribute fancy-footer widgets.

For users

• Contributed widgets appear in a separate Extension widgets section in /fancy-footer.
• Their overrides are stored in extensionWidgets inside ~/.pi/agent/fancy-footer.json.
• They use the same layout controls as built-in widgets, so you can mix and match them on any footer row.

For extension developers

If your extension depends on pi-fancy-footer, import the helper API from pi-fancy-footer/api:

import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { contributeFancyFooterWidgets } from "pi-fancy-footer/api";

export default function (pi: ExtensionAPI) {
  contributeFancyFooterWidgets(pi, {
    id: "acme.build-status",
    label: "Build status",
    icon: {
      nerd: "󰙨",
      emoji: "🧪",
      unicode: "◈",
      ascii: "B",
    },
    row: 1,
    order: 8,
    align: "right",
    render: () => "passing",
  });
}

Available helpers:

• defineFancyFooterWidget(widget) - identity helper for typing widget definitions.
• contributeFancyFooterWidgets(pi, widgetOrWidgets) - register one or more widgets for discovery.
• requestFancyFooterWidgetDiscovery(pi) - ask pi-fancy-footer to re-discover contributed widgets.
• requestFancyFooterRefresh(pi) - ask the footer to re-render immediately.

Each contributed widget defines:

• id - stable config key, ideally namespaced like vendor.widget-name
• render(ctx, availableWidth?) - widget renderer; return undefined, null, false, or an empty string to hide the widget
• label - display name in /fancy-footer (defaults to id)
• description - help text in the config UI (defaults to label/id)
• row, order, align, grow, and minWidth - optional default layout controls
• icon - a single icon, per-family icon map, function, or false/omitted to render without a leading icon
• optional textColor and styled

🔣 Icon families

The following table shows the symbol used by each widget for each icon family. For git-status, the table shows the rendered status symbols rather than a leading widget icon.

[!NOTE] Some glyphs, especially in the nerd family, may not render in your browser. If a cell looks blank or shows a replacement box, check the table in a terminal with the relevant font installed.

Widget	nerd	emoji	unicode	ascii
model	󰚩	🤖	◉	%
thinking	󰧑	🧠	✦	?
context-capacity		💾	□	[]
context-bar	󰾆	🔋	◧	|
total-cost	󰇁	💲	$	$
location		📁	⌂	/
branch		🌿	⎇	*
commit		🔖	#	#
pull-request		🔀	⇄	@
pull-request-review-threads	󰅺	💬	✎	!
pull-request-ci-status	//	⏳/❌/✅	◷/✕/✓	~/x/+
provider-status	󰓅	📊	%	%
diff-added	↗	➕	+	+
diff-removed	↘	➖	−	-
git-status	//	🔼/🔽/🔀	↑/↓/↕	^/_/<>

Notes:

• Most widgets use a leading icon.
• context-bar renders a battery-style mini gauge of remaining context, e.g. ■■■□□ 55%, spanning gaugeWidth cells with the glyphs from gaugeStyle (not iconFamily). Filled cells show the remaining share, colored via gaugeColors by how close the context is to exhaustion; empty cells stay dim. It sits on the left of the top row by default, with provider quota gauges on the right.
• git-status uses symbols for ahead / behind / diverged status.
• pull-request-ci-status is icon-only and uses symbols for running / failed / okay status. By default it uses semantic colors (warning / error / success); set this widget's icon color to override them.
• provider-status shows provider quota windows, currently for OpenAI Codex, as battery-style mini gauges per window, e.g. 5h ▰▰▰▰▱ 80% 7d ▰▰▱▱▱ 38%, where filled cells show the remaining quota and each window is colored by how close it is to exhaustion. The gauge spans gaugeWidth cells and reuses the configured gaugeStyle glyphs; set providerStatus.display to text for the compact 5h:95% 7d:97% form. It uses existing pi OpenAI Codex credentials from ~/.pi/agent/auth.json, falling back to Codex CLI credentials in ~/.codex/auth.json, and caches status under ~/.cache/pi-fancy-footer/provider-status/.
• provider-status also refreshes from x-codex-* provider response headers when pi exposes them, avoiding a separate status request after provider calls.
• iconFamily lets you choose between nerd, emoji, unicode, and ascii palettes.
• nerd keeps the original Nerd Font look. emoji, unicode, and ascii work better in terminals that don't use a Nerd Font.
• Per-widget icon overrides only let you hide the icon. The selected iconFamily controls which icon each widget uses.
• The PR widgets appear only for open GitHub pull requests and rely on the GitHub CLI (gh) being available and authenticated.
• pull-request-review-threads counts unresolved GitHub review threads on the current PR.
• pull-request-ci-status shows GitHub Actions workflow runs for the current PR head commit. It links to the relevant run and switches to failed as soon as one workflow fails, even when other workflows are still running.

🧱 Gauge styles

The gaugeStyle setting controls the characters used by the context-bar and provider-status gauges. Each style defines symbols for filled and empty cells:

Style	Filled	Empty
blocks (default)	■	□
lines	━	─
circles	●	○
parallelograms	▰	▱
diamonds	◆	◇
bars	█	░
stars	★	☆
specks	•	◦

🧹 Uninstall

pi remove npm:pi-fancy-footer

📄 License

MIT