pi-hud 0.1.1 → 0.1.3
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.
- package/README.md +23 -3
- package/assets/hud.png +0 -0
- package/extensions/hud.ts +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,9 +1,19 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
# pi-hud
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/pi-hud)
|
|
6
|
+
[](https://pi.dev/packages/pi-hud?name=hud)
|
|
7
|
+
[](https://github.com/ludevdot/pi-hud/actions/workflows/ci.yml)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
[](https://github.com/ludevdot/pi-hud/stargazers)
|
|
10
|
+
|
|
11
|
+
Persistent right-side HUD for [Pi](https://pi.dev), published as a Pi package at [pi.dev/packages/pi-hud](https://pi.dev/packages/pi-hud?name=hud).
|
|
4
12
|
|
|
5
13
|
It shows the current session, model/context usage, subagent activity, project path, and git branch without stealing focus from the editor.
|
|
6
14
|
|
|
15
|
+
|
|
16
|
+
|
|
7
17
|
## Features
|
|
8
18
|
|
|
9
19
|
- Starts visible by default when the extension is installed.
|
|
@@ -19,7 +29,7 @@ It shows the current session, model/context usage, subagent activity, project pa
|
|
|
19
29
|
- token/context count when available.
|
|
20
30
|
- Session context usage and cost.
|
|
21
31
|
- Project path and current git branch.
|
|
22
|
-
- MCP server names when `pi-mcp-adapter` is installed.
|
|
32
|
+
- Configured MCP server names when `pi-mcp-adapter` is installed.
|
|
23
33
|
|
|
24
34
|
## Install
|
|
25
35
|
|
|
@@ -98,11 +108,21 @@ Shortcut changes require `/reload` because shortcuts are registered when the ext
|
|
|
98
108
|
|
|
99
109
|
## Notes
|
|
100
110
|
|
|
101
|
-
- MCP servers are shown only when Pi has [`pi-mcp-adapter`](https://pi.dev/packages/pi-mcp-adapter?name=pi-mcp-adap) installed; config files alone do not enable the section.
|
|
111
|
+
- Configured MCP servers are shown only when Pi has [`pi-mcp-adapter`](https://pi.dev/packages/pi-mcp-adapter?name=pi-mcp-adap) installed; config files alone do not enable the section.
|
|
102
112
|
- Subagent status is based on Pi extension events and `pi-subagents` tool/result shapes when available.
|
|
103
113
|
- The HUD auto-compacts for the full assistant turn and expands when the turn ends, instead of changing state on each reasoning update.
|
|
104
114
|
- The overlay is hidden on narrow terminals under the configured `minTerminalWidth`.
|
|
105
115
|
|
|
116
|
+
## Known limitations
|
|
117
|
+
|
|
118
|
+
### MCP connection status
|
|
119
|
+
|
|
120
|
+
The HUD shows configured MCP server names, not live connection status. It reads global and project MCP config paths and renders the configured names when `pi-mcp-adapter` is installed.
|
|
121
|
+
|
|
122
|
+
For example, a project-local `.mcp.json` can make a server appear in the HUD even when that server is not currently connected. Use `mcp({})` or `/mcp` for live MCP status.
|
|
123
|
+
|
|
124
|
+
`pi-mcp-adapter` does not currently expose a public cross-extension status API for `pi-hud` to consume. If such an API becomes available, `pi-hud` can show live states such as connected, cached, failed, needs-auth, or not connected.
|
|
125
|
+
|
|
106
126
|
## Inspiration
|
|
107
127
|
|
|
108
128
|
`pi-hud` is inspired by [sub-agent-statusline](https://github.com/Joaquinvesapa/sub-agent-statusline).
|
package/assets/hud.png
ADDED
|
Binary file
|
package/extensions/hud.ts
CHANGED
|
@@ -347,7 +347,7 @@ class HudComponent implements Component {
|
|
|
347
347
|
}
|
|
348
348
|
|
|
349
349
|
if (mcpAdapter.available) {
|
|
350
|
-
this.pushSection(lines, innerWidth, "
|
|
350
|
+
this.pushSection(lines, innerWidth, "Configured MCPs");
|
|
351
351
|
if (mcpAdapter.servers.length === 0) {
|
|
352
352
|
this.pushLine(lines, innerWidth, this.theme.fg("dim", "adapter installed"));
|
|
353
353
|
} else {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pi-hud",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "A persistent hud for Pi with context, project, and subagent status.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"@earendil-works/pi-coding-agent": "0.74.1",
|
|
47
47
|
"@earendil-works/pi-tui": "0.74.1",
|
|
48
48
|
"vitest": "3.2.4",
|
|
49
|
-
"tsx": "4.
|
|
49
|
+
"tsx": "4.21.0",
|
|
50
50
|
"typescript": "5.9.2"
|
|
51
51
|
},
|
|
52
52
|
"engines": {
|