@pi-archimedes/footer 2.5.0 → 2.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +25 -21
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,45 +1,49 @@
1
1
  # @pi-archimedes/footer
2
2
 
3
- A status bar that shows what matters — at a glance, without getting in the way.
3
+ **Session details without scrolling.**
4
4
 
5
- Your terminal is already full of information. The footer gives you exactly what you need to know about your session — where you are, what model you're using, how many tokens you've burned, and how close you are to the context limit — laid out at the bottom of the terminal, adapting to its width without ever clipping. When subagents run, their costs merge seamlessly into the same view.
6
-
7
- ## What you get
8
-
9
- - **Session context at a glance** — directory, git branch (with clean/dirty indicators), active model, thinking level; the branch icon switches from `⎇` to `🌲` when cwd is inside a linked worktree — no extra chip, no duplication
10
- - **Token stats** — input ↑, output ↓, cache read/write, and real-dollar cost, all in one compact display
11
- - **Context window bar** — color-coded progress bar (green → yellow → red) showing how much of your context window is used
12
- - **Adaptive layout** — everything on one line when it fits; otherwise it wraps to additional lines (two or three) instead of clipping. Width at which it switches is configurable
13
- - **Unified subagent costs** — when subagents run, their token usage and cost merge into the main footer automatically
5
+ A long session drags context out of reach fast. The footer keeps the essentials pinned to the bottom of the terminal — where you are, which model you're running, how deep you are into the context window, and what you've spent — laying them out without clipping on any viewport width. When subagents run, their tokens and costs land in the same view, so the number you're watching is the whole run.
14
6
 
15
7
  ## Install
16
8
 
9
+ Standalone:
10
+
17
11
  ```bash
18
12
  pi install npm:@pi-archimedes/footer
19
13
  ```
20
14
 
21
- Or install full meta package:
15
+ Or the full suite instead:
22
16
 
23
17
  ```bash
24
18
  pi install npm:pi-archimedes
25
19
  ```
26
20
 
27
- ## Usage
21
+ New to Pi? Pi itself is a one-time global install and needs Node.js ≥ 22.19.0:
28
22
 
29
- Footer renders automatically at the bottom of the Pi TUI. No commands to run.
23
+ ```bash
24
+ npm install -g --ignore-scripts @earendil-works/pi-coding-agent
25
+ ```
30
26
 
31
- On wide terminals, the footer displays as one compact line with all session context, token usage, cost, and a context window progress bar that fills the remaining space. When that no longer fits on one line, the footer wraps — usage moves to a second line, and sections themselves overflow to a third line if the terminal is truly narrow — so nothing ever gets clipped. Below the configured split threshold, it always uses at least the two-line layout (system info above, stats below).
27
+ After installing Pi, choose one installation command above, then `cd` into your project and run `pi`. Inside the session, `/login` signs you in and `/model` picks a model — the [setup section](https://github.com/danielcherubini/pi-archimedes#setup) walks through the whole first run. A running session picks the footer up with `/reload`.
28
+
29
+ ## What you get
30
+
31
+ - **Session line** — working directory, active git branch with clean/dirty indicator, worktree badge, active model, and thinking level.
32
+ - **Token ledger** — input (↑) and output (↓) tokens, cache read/write, and the live accumulated dollar cost of the session.
33
+ - **Context bar** — colour-coded (green → yellow → red). It shows **consumption**: how much of the context window is used, not how much headroom is left.
34
+ - **Adaptive layout** — one compact line on wide viewports; it wraps to the lines it needs as the terminal narrows instead of truncating essential data.
35
+ - **Subagent aggregation** — in the suite, subagent token and cost events flow over core's bus into the same accumulator, so worker spend and main-session spend read as one total.
36
+
37
+ Two honest caveats: the ledger reflects usage and pricing **as reported to the session** — it's a live read of what Pi has accounted, not a guaranteed provider invoice, and not a tally of every background model call. And the context bar tracks consumption, not remaining headroom.
32
38
 
33
39
  ## Settings
34
40
 
41
+ `~/.pi/agent/settings.json`, under `archimedes.footer` (strict JSON):
42
+
35
43
  | Setting | Type | Default | Description |
36
44
  |---------|------|---------|-------------|
37
- | `splitThreshold` | number | `150` | Minimum terminal width (columns) where a single-line footer is still allowed. Below it, the footer always uses at least the two-line layout; above it, it stays on one line as long as the content fits and wraps otherwise — never clipping. |
38
-
39
- Settings are stored in `~/.pi/agent/settings.json` under the `archimedes.footer` namespace.
40
-
41
- ## Integration
45
+ | `splitThreshold` | number | `150` | Minimum terminal columns for the single-line layout. Below it, the footer uses the structured multi-line layout; above it, it stays single-line and wraps only if content overflows. |
42
46
 
43
- When installed via the meta package, footer consumes cost events from subagents through the core bus, giving a unified token/cost view across the main agent and any running subagents. Standalone install shows only the main agent's stats.
47
+ In the suite the setting also appears in `/archimedes` (when the panel has a control for it); `/reload` applies it. On/off is managed by the suite: toggle via `/plugins` (`archimedes.footer.enabled`, default on).
44
48
 
45
- ← Back to [pi-archimedes](../../README.md)
49
+ ← [Back to pi-archimedes](https://github.com/danielcherubini/pi-archimedes)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pi-archimedes/footer",
3
- "version": "2.5.0",
3
+ "version": "2.6.2",
4
4
  "type": "module",
5
5
  "keywords": [
6
6
  "pi-package"
@@ -15,15 +15,15 @@
15
15
  "./config": "./src/config.ts"
16
16
  },
17
17
  "dependencies": {
18
- "@pi-archimedes/core": "2.5.0"
18
+ "@pi-archimedes/core": "2.6.2"
19
19
  },
20
20
  "peerDependencies": {
21
21
  "@earendil-works/pi-coding-agent": ">=0.1.0",
22
22
  "@earendil-works/pi-tui": ">=0.1.0"
23
23
  },
24
24
  "devDependencies": {
25
- "@earendil-works/pi-coding-agent": "^0.84.4",
26
- "@earendil-works/pi-tui": "^0.84.4",
25
+ "@earendil-works/pi-coding-agent": "^0.85.1",
26
+ "@earendil-works/pi-tui": "^0.85.1",
27
27
  "typescript": "^6.0.0"
28
28
  },
29
29
  "pi": {