pi-open-tui 0.2.10 → 0.2.12

package/README.md

@@ -1,103 +1,105 @@
-# pi-open-tui
-
-A polished TUI for [Pi](https://pi.dev) coding agent. Combines the best of pi-haiku, pi-claude-code-tui, and pi-zentui into one cohesive package.
-
-![Preview](https://raw.githubusercontent.com/OldSuns/pi-open-tui/main/assets/preview_dashboard_1.png)
-
-## What's in it
-
-- **Animated Pi logo header** — 16-frame color-changing logo animation + "Let's build something great" tagline
-- **Starship-style footer** — 2 lines showing cwd, git branch/status, runtime version, context bar, model, token counts, and cost
-- **Rounded editor** — accent rail + borderMuted rounded corners, clean visual frame
-- **60+ runtime detection** — Node, Rust, Go, Python, Ruby, Java, Swift, Kotlin, C/C++, Deno, Bun, and many more
-- **Git status** — branch, ahead/behind, modified/untracked/staged/stashed, detached HEAD commit hash + tag
-- **Working timer** — live elapsed time while the agent is working, done duration when finished
-- **Turn telemetry** — generation speed, TTFT, stalls, tokens, and list-price rate after each complete agent run
-- **Zero prototype patches** — uses public Pi APIs (setHeader/setFooter/setEditorComponent), safe across Pi updates
-- **Interactive settings UI** — `/open-tui` opens a tabbed settings dialog (General / Icons / Footer / Telemetry)
-
-## Install
-
-```bash
-pi install npm:pi-open-tui
-```
-
-Or try it for one run:
-
-```bash
-pi -e npm:pi-open-tui
-```
-
-## Configuration
-
-Run `/open-tui` to open the interactive settings UI. Configuration is stored at `~/.pi/agent/open-tui.json`:
-
-```json
-{
-  "enabled": true,
-  "settingsLanguage": "en",
-  "icons": {
-    "mode": "auto"
-  },
-  "footerSegments": {
-    "cwd": true,
-    "gitBranch": true,
-    "gitStatus": true,
-    "gitCommit": false,
-    "runtime": true,
-    "context": true,
-    "tokens": true,
-    "cost": true,
-    "extensionStatuses": true
-  },
-  "telemetry": {
-    "enabled": true,
-    "tps": true,
-    "ttft": true,
-    "duration": true,
-    "tokens": true,
-    "stalls": true,
-    "cost": true
-  }
-}
-```
-
-- `settingsLanguage`: language for the `/open-tui` settings UI only; `en` or `zh`
-- `icons.mode`: `auto` (detect Nerd Font), `nerd` (force Nerd Font glyphs), or `ascii` (plain fallbacks)
-- `footerSegments.gitCommit`: shows short hash + tag on detached HEAD (off by default)
-- `footerSegments.extensionStatuses`: shows statuses published by extensions through Pi's `setStatus()` API (on by default); turn it off to hide the whole status line, including MCP
-
-## Turn telemetry
-
-After each complete agent run, open-tui shows one transient notification. Tool-call turns are aggregated into that single result:
-
-```text
-> TPS 42.5 tok/s | ~ TTFT 1.2s | + 29.7s | ↑ 567 | ↓ 1.2k | ! stall 1x / 4.3s | $ $3.60/M
-```
-
-The notification uses the footer's icon mode and semantic theme colors. Configure its master switch and individual TPS, TTFT, duration, token, stall, and cost segments from the **Telemetry** tab in `/open-tui`.
-
-TPS is the complete generation throughput for the agent run: all provider-reported assistant output tokens divided by the summed generation time of every LLM turn, measured from `turn_start` through the assistant `message_end`. This includes time-to-first-token, hidden reasoning, buffering, and stalls so the token count and timing cover the same interval. Tool execution between turns is excluded. A run with no output tokens or no measurable generation time is shown as `TPS —`. The `stall` segment shows occurrence count followed by accumulated duration. The optional `$ / M` value uses the model's list-price `usage.cost.total`; it is not the session's cumulative cost shown in the footer.
-
-## Local development
-
-```bash
-pi -e .
-```
-
-## License
-
-MIT
-
-## Acknowledgements
-
-This project builds on the work of several Pi community packages:
-
-- **[pi-haiku](https://github.com/nnocte/pi-haiku)** — the 2-line footer structure (location+model · timer+context) and working-timer pattern
-- **[pi-claude-code-tui](https://github.com/Phoobobo/pi-claude-code-tui)** — the 16-frame animated Pi logo and rounded editor border technique
-- **[pi-zentui](https://github.com/lmilojevicc/pi-zentui)** — the Starship-style footer segments (git status icons, runtime detection, context gauge), generation-based session lifecycle, and interactive settings UI pattern
-- **[pi-tps](https://github.com/monotykamary/pi-tps)** — the turn timing, stall detection, and conservative TPS measurement approach
-
-The animated logo frames are derived from `pi-claude-code-tui`, which in turn derive from Pi's official install script (`pi.dev/install.sh`). The runtime detection list and git porcelain parsing borrow structure from `pi-zentui`.
-
-Special thanks to the **[LINUX DO](https://linux.do)** community for their support.
+# pi-open-tui
+
+A polished TUI for [Pi](https://pi.dev) coding agent. Combines the best of pi-haiku, pi-claude-code-tui, and pi-zentui into one cohesive package.
+
+![Preview](https://raw.githubusercontent.com/OldSuns/pi-open-tui/main/assets/preview_dashboard_1.png)
+
+## What's in it
+
+- **Animated Pi logo header** — 16-frame color-changing logo animation + "Let's build something great" tagline
+- **Starship-style footer** — 2 lines showing cwd, git branch/status, runtime version, context bar, model, token counts, and cost
+- **Rounded editor** — accent rail + borderMuted rounded corners, clean visual frame
+- **60+ runtime detection** — Node, Rust, Go, Python, Ruby, Java, Swift, Kotlin, C/C++, Deno, Bun, and many more
+- **Git status** — branch, ahead/behind, modified/untracked/staged/stashed, detached HEAD commit hash + tag
+- **Working timer** — live elapsed time while the agent is working, done duration when finished
+- **Turn telemetry** — generation speed, TTFT, stalls, tokens, and list-price rate after each complete agent run
+- **Zero prototype patches** — uses public Pi APIs (setHeader/setFooter/setEditorComponent), safe across Pi updates
+- **Interactive settings UI** — `/open-tui` opens a tabbed settings dialog (General / Icons / Footer / Telemetry)
+
+## Install
+
+```bash
+pi install npm:pi-open-tui
+```
+
+Or try it for one run:
+
+```bash
+pi -e npm:pi-open-tui
+```
+
+## Configuration
+
+Run `/open-tui` to open the interactive settings UI. Configuration is stored at `~/.pi/agent/open-tui.json`:
+
+```json
+{
+  "enabled": true,
+  "settingsLanguage": "en",
+  "icons": {
+    "mode": "auto"
+  },
+  "footerSegments": {
+    "cwd": true,
+    "sessionName": false,
+    "gitBranch": true,
+    "gitStatus": true,
+    "gitCommit": false,
+    "runtime": true,
+    "context": true,
+    "tokens": true,
+    "cost": true,
+    "extensionStatuses": true
+  },
+  "telemetry": {
+    "enabled": true,
+    "tps": true,
+    "ttft": true,
+    "duration": true,
+    "tokens": true,
+    "stalls": true,
+    "cost": true
+  }
+}
+```
+
+- `settingsLanguage`: language for the `/open-tui` settings UI only; `en` or `zh`
+- `icons.mode`: `auto` (detect Nerd Font), `nerd` (force Nerd Font glyphs), or `ascii` (plain fallbacks)
+- `footerSegments.sessionName`: shows the current session name next to cwd (off by default); hidden when the session has no name
+- `footerSegments.gitCommit`: shows short hash + tag on detached HEAD (off by default)
+- `footerSegments.extensionStatuses`: shows statuses published by extensions through Pi's `setStatus()` API (on by default); turn it off to hide the whole status line, including MCP
+
+## Turn telemetry
+
+After each complete agent run, open-tui shows one transient notification. Tool-call turns are aggregated into that single result:
+
+```text
+> TPS 42.5 tok/s | ~ TTFT 1.2s | + 29.7s | ↑ 567 | ↓ 1.2k | ! stall 1x / 4.3s | $ $3.60/M
+```
+
+The notification uses the footer's icon mode and semantic theme colors. Configure its master switch and individual TPS, TTFT, duration, token, stall, and cost segments from the **Telemetry** tab in `/open-tui`.
+
+TPS is the complete generation throughput for the agent run: all provider-reported assistant output tokens divided by the summed generation time of every LLM turn, measured from `turn_start` through the assistant `message_end`. This includes time-to-first-token, hidden reasoning, buffering, and stalls so the token count and timing cover the same interval. Tool execution between turns is excluded. A run with no output tokens or no measurable generation time is shown as `TPS —`. The `stall` segment shows occurrence count followed by accumulated duration. The optional `$ / M` value uses the model's list-price `usage.cost.total`; it is not the session's cumulative cost shown in the footer.
+
+## Local development
+
+```bash
+pi -e .
+```
+
+## License
+
+MIT
+
+## Acknowledgements
+
+This project builds on the work of several Pi community packages:
+
+- **[pi-haiku](https://github.com/nnocte/pi-haiku)** — the 2-line footer structure (location+model · timer+context) and working-timer pattern
+- **[pi-claude-code-tui](https://github.com/Phoobobo/pi-claude-code-tui)** — the 16-frame animated Pi logo and rounded editor border technique
+- **[pi-zentui](https://github.com/lmilojevicc/pi-zentui)** — the Starship-style footer segments (git status icons, runtime detection, context gauge), generation-based session lifecycle, and interactive settings UI pattern
+- **[pi-tps](https://github.com/monotykamary/pi-tps)** — the turn timing, stall detection, and conservative TPS measurement approach
+
+The animated logo frames are derived from `pi-claude-code-tui`, which in turn derive from Pi's official install script (`pi.dev/install.sh`). The runtime detection list and git porcelain parsing borrow structure from `pi-zentui`.
+
+Special thanks to the **[LINUX DO](https://linux.do)** community for their support.

package/extensions/open-tui/config.ts

@@ -1,139 +1,141 @@
-import { existsSync, readFileSync, writeFileSync, mkdirSync } from "node:fs";
-import { join } from "node:path";
-import { getAgentDir } from "@earendil-works/pi-coding-agent";
-import type { IconMode } from "./icons.ts";
-
-export type SettingsLanguage = "en" | "zh";
-
-export type { IconMode } from "./icons.ts";
-
-export interface FooterSegments {
-	cwd: boolean;
-	gitBranch: boolean;
-	gitStatus: boolean;
-	gitCommit: boolean;
-	runtime: boolean;
-	context: boolean;
-	tokens: boolean;
-	cost: boolean;
-	extensionStatuses: boolean;
-}
-
-export interface TelemetryConfig {
-	enabled: boolean;
-	tps: boolean;
-	ttft: boolean;
-	duration: boolean;
-	tokens: boolean;
-	stalls: boolean;
-	cost: boolean;
-}
-
-export interface OpenTuiConfig {
-	enabled: boolean;
-	settingsLanguage: SettingsLanguage;
-	icons: {
-		mode: IconMode;
-	};
-	footerSegments: FooterSegments;
-	telemetry: TelemetryConfig;
-}
-
-export const DEFAULT_CONFIG: OpenTuiConfig = {
-	enabled: true,
-	settingsLanguage: "en",
-	icons: {
-		mode: "auto",
-	},
-	footerSegments: {
-		cwd: true,
-		gitBranch: true,
-		gitStatus: true,
-		gitCommit: false,
-		runtime: true,
-		context: true,
-		tokens: true,
-		cost: true,
-		extensionStatuses: true,
-	},
-	telemetry: {
-		enabled: true,
-		tps: true,
-		ttft: true,
-		duration: true,
-		tokens: true,
-		stalls: true,
-		cost: true,
-	},
-};
-
-export function getConfigPath(): string {
-	const agentDir = getAgentDir();
-	return join(agentDir, "open-tui.json");
-}
-
-function deepMerge<T>(base: T, override: unknown): T {
-	if (typeof base !== "object" || base === null || Array.isArray(base)) {
-		return (override as T) ?? base;
-	}
-	if (typeof override !== "object" || override === null || Array.isArray(override)) {
-		return base;
-	}
-	const result = { ...(base as Record<string, unknown>) };
-	const overrideRec = override as Record<string, unknown>;
-	for (const key of Object.keys(overrideRec)) {
-		const baseVal = (base as Record<string, unknown>)[key];
-		const overVal = overrideRec[key];
-		if (typeof baseVal === "object" && baseVal !== null && !Array.isArray(baseVal)
-			&& typeof overVal === "object" && overVal !== null && !Array.isArray(overVal)) {
-			result[key] = deepMerge(baseVal, overVal);
-		} else if (overVal !== undefined) {
-			result[key] = overVal;
-		}
-	}
-	return result as T;
-}
-
-export function ensureConfigExists(): void {
-	const path = getConfigPath();
-	if (existsSync(path)) return;
-	try {
-		const agentDir = getAgentDir();
-		if (!existsSync(agentDir)) mkdirSync(agentDir, { recursive: true });
-		writeFileSync(path, JSON.stringify(DEFAULT_CONFIG, null, 2) + "\n", "utf8");
-	} catch {
-		// ponytail: silent fallback — config creation is best-effort
-	}
-}
-
-export function loadConfig(notify?: (msg: string, level: "warning" | "info") => void): OpenTuiConfig {
-	const path = getConfigPath();
-	if (!existsSync(path)) {
-		ensureConfigExists();
-		return structuredClone(DEFAULT_CONFIG);
-	}
-
-	try {
-		const raw = readFileSync(path, "utf8");
-		const parsed: unknown = JSON.parse(raw);
-		const config = deepMerge(DEFAULT_CONFIG, parsed);
-		if (config.settingsLanguage !== "en" && config.settingsLanguage !== "zh") {
-			config.settingsLanguage = DEFAULT_CONFIG.settingsLanguage;
-		}
-		return config;
-	} catch (err) {
-		notify?.(`open-tui config parse error: ${err instanceof Error ? err.message : String(err)}`, "warning");
-		return structuredClone(DEFAULT_CONFIG);
-	}
-}
-
-export function saveConfig(config: OpenTuiConfig): void {
-	const path = getConfigPath();
-	try {
-		const agentDir = getAgentDir();
-		if (!existsSync(agentDir)) mkdirSync(agentDir, { recursive: true });
-		writeFileSync(path, JSON.stringify(config, null, 2) + "\n", "utf8");
-	} catch {
-		// ponytail: silent fallback — config save is best-effort
-	}
-}
+import { existsSync, readFileSync, writeFileSync, mkdirSync } from "node:fs";
+import { join } from "node:path";
+import { getAgentDir } from "@earendil-works/pi-coding-agent";
+import type { IconMode } from "./icons.ts";
+
+export type SettingsLanguage = "en" | "zh";
+
+export type { IconMode } from "./icons.ts";
+
+export interface FooterSegments {
+	cwd: boolean;
+	sessionName: boolean;
+	gitBranch: boolean;
+	gitStatus: boolean;
+	gitCommit: boolean;
+	runtime: boolean;
+	context: boolean;
+	tokens: boolean;
+	cost: boolean;
+	extensionStatuses: boolean;
+}
+
+export interface TelemetryConfig {
+	enabled: boolean;
+	tps: boolean;
+	ttft: boolean;
+	duration: boolean;
+	tokens: boolean;
+	stalls: boolean;
+	cost: boolean;
+}
+
+export interface OpenTuiConfig {
+	enabled: boolean;
+	settingsLanguage: SettingsLanguage;
+	icons: {
+		mode: IconMode;
+	};
+	footerSegments: FooterSegments;
+	telemetry: TelemetryConfig;
+}
+
+export const DEFAULT_CONFIG: OpenTuiConfig = {
+	enabled: true,
+	settingsLanguage: "en",
+	icons: {
+		mode: "auto",
+	},
+	footerSegments: {
+		cwd: true,
+		sessionName: false,
+		gitBranch: true,
+		gitStatus: true,
+		gitCommit: false,
+		runtime: true,
+		context: true,
+		tokens: true,
+		cost: true,
+		extensionStatuses: true,
+	},
+	telemetry: {
+		enabled: true,
+		tps: true,
+		ttft: true,
+		duration: true,
+		tokens: true,
+		stalls: true,
+		cost: true,
+	},
+};
+
+export function getConfigPath(): string {
+	const agentDir = getAgentDir();
+	return join(agentDir, "open-tui.json");
+}
+
+function deepMerge<T>(base: T, override: unknown): T {
+	if (typeof base !== "object" || base === null || Array.isArray(base)) {
+		return (override as T) ?? base;
+	}
+	if (typeof override !== "object" || override === null || Array.isArray(override)) {
+		return base;
+	}
+	const result = { ...(base as Record<string, unknown>) };
+	const overrideRec = override as Record<string, unknown>;
+	for (const key of Object.keys(overrideRec)) {
+		const baseVal = (base as Record<string, unknown>)[key];
+		const overVal = overrideRec[key];
+		if (typeof baseVal === "object" && baseVal !== null && !Array.isArray(baseVal)
+			&& typeof overVal === "object" && overVal !== null && !Array.isArray(overVal)) {
+			result[key] = deepMerge(baseVal, overVal);
+		} else if (overVal !== undefined) {
+			result[key] = overVal;
+		}
+	}
+	return result as T;
+}
+
+export function ensureConfigExists(): void {
+	const path = getConfigPath();
+	if (existsSync(path)) return;
+	try {
+		const agentDir = getAgentDir();
+		if (!existsSync(agentDir)) mkdirSync(agentDir, { recursive: true });
+		writeFileSync(path, JSON.stringify(DEFAULT_CONFIG, null, 2) + "\n", "utf8");
+	} catch {
+		// ponytail: silent fallback — config creation is best-effort
+	}
+}
+
+export function loadConfig(notify?: (msg: string, level: "warning" | "info") => void): OpenTuiConfig {
+	const path = getConfigPath();
+	if (!existsSync(path)) {
+		ensureConfigExists();
+		return structuredClone(DEFAULT_CONFIG);
+	}
+
+	try {
+		const raw = readFileSync(path, "utf8");
+		const parsed: unknown = JSON.parse(raw);
+		const config = deepMerge(DEFAULT_CONFIG, parsed);
+		if (config.settingsLanguage !== "en" && config.settingsLanguage !== "zh") {
+			config.settingsLanguage = DEFAULT_CONFIG.settingsLanguage;
+		}
+		return config;
+	} catch (err) {
+		notify?.(`open-tui config parse error: ${err instanceof Error ? err.message : String(err)}`, "warning");
+		return structuredClone(DEFAULT_CONFIG);
+	}
+}
+
+export function saveConfig(config: OpenTuiConfig): void {
+	const path = getConfigPath();
+	try {
+		const agentDir = getAgentDir();
+		if (!existsSync(agentDir)) mkdirSync(agentDir, { recursive: true });
+		writeFileSync(path, JSON.stringify(config, null, 2) + "\n", "utf8");
+	} catch {
+		// ponytail: silent fallback — config save is best-effort
+	}
+}