@phi-code-admin/phi-code 0.74.2 → 0.75.0

package/examples/extensions/trigger-compact.ts

@@ -0,0 +1,50 @@
+import type { ExtensionAPI, ExtensionContext } from "@phi-code-admin/phi-code";
+
+const COMPACT_THRESHOLD_TOKENS = 100_000;
+
+export default function (pi: ExtensionAPI) {
+	let previousTokens: number | null | undefined;
+
+	const triggerCompaction = (ctx: ExtensionContext, customInstructions?: string) => {
+		if (ctx.hasUI) {
+			ctx.ui.notify("Compaction started", "info");
+		}
+		ctx.compact({
+			customInstructions,
+			onComplete: () => {
+				if (ctx.hasUI) {
+					ctx.ui.notify("Compaction completed", "info");
+				}
+			},
+			onError: (error) => {
+				if (ctx.hasUI) {
+					ctx.ui.notify(`Compaction failed: ${error.message}`, "error");
+				}
+			},
+		});
+	};
+
+	pi.on("turn_end", (_event, ctx) => {
+		const usage = ctx.getContextUsage();
+		const currentTokens = usage?.tokens ?? null;
+		if (currentTokens === null) {
+			return;
+		}
+
+		const crossedThreshold =
+			previousTokens !== undefined && previousTokens !== null && previousTokens <= COMPACT_THRESHOLD_TOKENS;
+		previousTokens = currentTokens;
+		if (!crossedThreshold || currentTokens <= COMPACT_THRESHOLD_TOKENS) {
+			return;
+		}
+		triggerCompaction(ctx);
+	});
+
+	pi.registerCommand("trigger-compact", {
+		description: "Trigger compaction immediately",
+		handler: async (args, ctx) => {
+			const instructions = args.trim() || undefined;
+			triggerCompaction(ctx, instructions);
+		},
+	});
+}

package/examples/extensions/truncated-tool.ts

@@ -0,0 +1,195 @@
+/**
+ * Truncated Tool Example - Demonstrates proper output truncation for custom tools
+ *
+ * Custom tools MUST truncate their output to avoid overwhelming the LLM context.
+ * The built-in limit is 50KB (~10k tokens) and 2000 lines, whichever is hit first.
+ *
+ * This example shows how to:
+ * 1. Use the built-in truncation utilities
+ * 2. Write full output to a temp file when truncated
+ * 3. Inform the LLM where to find the complete output
+ * 4. Custom rendering of tool calls and results
+ *
+ * The `rg` tool here wraps ripgrep with proper truncation. Compare this to the
+ * built-in `grep` tool in src/core/tools/grep.ts for a more complete implementation.
+ */
+
+import { mkdtemp, writeFile } from "node:fs/promises";
+import type { ExtensionAPI } from "@phi-code-admin/phi-code";
+import {
+	DEFAULT_MAX_BYTES,
+	DEFAULT_MAX_LINES,
+	formatSize,
+	type TruncationResult,
+	truncateHead,
+	withFileMutationQueue,
+} from "@phi-code-admin/phi-code";
+import { execSync } from "child_process";
+import { tmpdir } from "os";
+import { join } from "path";
+import { Text } from "phi-code-tui";
+import { Type } from "typebox";
+
+const RgParams = Type.Object({
+	pattern: Type.String({ description: "Search pattern (regex)" }),
+	path: Type.Optional(Type.String({ description: "Directory to search (default: current directory)" })),
+	glob: Type.Optional(Type.String({ description: "File glob pattern, e.g. '*.ts'" })),
+});
+
+interface RgDetails {
+	pattern: string;
+	path?: string;
+	glob?: string;
+	matchCount: number;
+	truncation?: TruncationResult;
+	fullOutputPath?: string;
+}
+
+export default function (pi: ExtensionAPI) {
+	pi.registerTool({
+		name: "rg",
+		label: "ripgrep",
+		// Document the truncation limits in the tool description so the LLM knows
+		description: `Search file contents using ripgrep. Output is truncated to ${DEFAULT_MAX_LINES} lines or ${formatSize(DEFAULT_MAX_BYTES)} (whichever is hit first). If truncated, full output is saved to a temp file.`,
+		parameters: RgParams,
+
+		async execute(_toolCallId, params, _signal, _onUpdate, ctx) {
+			const { pattern, path: searchPath, glob } = params;
+
+			// Build the ripgrep command
+			const args = ["rg", "--line-number", "--color=never"];
+			if (glob) args.push("--glob", glob);
+			args.push(pattern);
+			args.push(searchPath || ".");
+
+			let output: string;
+			try {
+				output = execSync(args.join(" "), {
+					cwd: ctx.cwd,
+					encoding: "utf-8",
+					maxBuffer: 100 * 1024 * 1024, // 100MB buffer to capture full output
+				});
+			} catch (err: any) {
+				// ripgrep exits with 1 when no matches found
+				if (err.status === 1) {
+					return {
+						content: [{ type: "text", text: "No matches found" }],
+						details: { pattern, path: searchPath, glob, matchCount: 0 } as RgDetails,
+					};
+				}
+				throw new Error(`ripgrep failed: ${err.message}`);
+			}
+
+			if (!output.trim()) {
+				return {
+					content: [{ type: "text", text: "No matches found" }],
+					details: { pattern, path: searchPath, glob, matchCount: 0 } as RgDetails,
+				};
+			}
+
+			// Apply truncation using built-in utilities
+			// truncateHead keeps the first N lines/bytes (good for search results)
+			// truncateTail keeps the last N lines/bytes (good for logs/command output)
+			const truncation = truncateHead(output, {
+				maxLines: DEFAULT_MAX_LINES,
+				maxBytes: DEFAULT_MAX_BYTES,
+			});
+
+			// Count matches (each non-empty line with a match)
+			const matchCount = output.split("\n").filter((line) => line.trim()).length;
+
+			const details: RgDetails = {
+				pattern,
+				path: searchPath,
+				glob,
+				matchCount,
+			};
+
+			let resultText = truncation.content;
+
+			if (truncation.truncated) {
+				// Save full output to a temp file so LLM can access it if needed
+				const tempDir = await mkdtemp(join(tmpdir(), "pi-rg-"));
+				const tempFile = join(tempDir, "output.txt");
+				await withFileMutationQueue(tempFile, async () => {
+					await writeFile(tempFile, output, "utf8");
+				});
+
+				details.truncation = truncation;
+				details.fullOutputPath = tempFile;
+
+				// Add truncation notice - this helps the LLM understand the output is incomplete
+				const truncatedLines = truncation.totalLines - truncation.outputLines;
+				const truncatedBytes = truncation.totalBytes - truncation.outputBytes;
+
+				resultText += `\n\n[Output truncated: showing ${truncation.outputLines} of ${truncation.totalLines} lines`;
+				resultText += ` (${formatSize(truncation.outputBytes)} of ${formatSize(truncation.totalBytes)}).`;
+				resultText += ` ${truncatedLines} lines (${formatSize(truncatedBytes)}) omitted.`;
+				resultText += ` Full output saved to: ${tempFile}]`;
+			}
+
+			return {
+				content: [{ type: "text", text: resultText }],
+				details,
+			};
+		},
+
+		// Custom rendering of the tool call (shown before/during execution)
+		renderCall(args, theme, _context) {
+			let text = theme.fg("toolTitle", theme.bold("rg "));
+			text += theme.fg("accent", `"${args.pattern}"`);
+			if (args.path) {
+				text += theme.fg("muted", ` in ${args.path}`);
+			}
+			if (args.glob) {
+				text += theme.fg("dim", ` --glob ${args.glob}`);
+			}
+			return new Text(text, 0, 0);
+		},
+
+		// Custom rendering of the tool result
+		renderResult(result, { expanded, isPartial }, theme, _context) {
+			const details = result.details as RgDetails | undefined;
+
+			// Handle streaming/partial results
+			if (isPartial) {
+				return new Text(theme.fg("warning", "Searching..."), 0, 0);
+			}
+
+			// No matches
+			if (!details || details.matchCount === 0) {
+				return new Text(theme.fg("dim", "No matches found"), 0, 0);
+			}
+
+			// Build result display
+			let text = theme.fg("success", `${details.matchCount} matches`);
+
+			// Show truncation warning if applicable
+			if (details.truncation?.truncated) {
+				text += theme.fg("warning", " (truncated)");
+			}
+
+			// In expanded view, show the actual matches
+			if (expanded) {
+				const content = result.content[0];
+				if (content?.type === "text") {
+					// Show first 20 lines in expanded view, or all if fewer
+					const lines = content.text.split("\n").slice(0, 20);
+					for (const line of lines) {
+						text += `\n${theme.fg("dim", line)}`;
+					}
+					if (content.text.split("\n").length > 20) {
+						text += `\n${theme.fg("muted", "... (use read tool to see full output)")}`;
+					}
+				}
+
+				// Show temp file path if truncated
+				if (details.fullOutputPath) {
+					text += `\n${theme.fg("dim", `Full output: ${details.fullOutputPath}`)}`;
+				}
+			}
+
+			return new Text(text, 0, 0);
+		},
+	});
+}

package/examples/extensions/widget-placement.ts

@@ -0,0 +1,9 @@
+import type { ExtensionAPI } from "@phi-code-admin/phi-code";
+
+export default function widgetPlacementExtension(pi: ExtensionAPI) {
+	pi.on("session_start", (_event, ctx) => {
+		if (!ctx.hasUI) return;
+		ctx.ui.setWidget("widget-above", ["Above editor widget"]);
+		ctx.ui.setWidget("widget-below", ["Below editor widget"], { placement: "belowEditor" });
+	});
+}

package/examples/extensions/with-deps/index.ts

@@ -0,0 +1,32 @@
+/**
+ * Example extension with its own npm dependencies.
+ * Tests that jiti resolves modules from the extension's own node_modules.
+ *
+ * Requires: npm install in this directory
+ */
+
+import type { ExtensionAPI } from "@phi-code-admin/phi-code";
+import ms from "ms";
+import { Type } from "typebox";
+
+export default function (pi: ExtensionAPI) {
+	// Register a tool that uses ms
+	pi.registerTool({
+		name: "parse_duration",
+		label: "Parse Duration",
+		description: "Parse a human-readable duration string (e.g., '2 days', '1h', '5m') to milliseconds",
+		parameters: Type.Object({
+			duration: Type.String({ description: "Duration string like '2 days', '1h', '5m'" }),
+		}),
+		execute: async (_toolCallId, params) => {
+			const result = ms(params.duration as ms.StringValue);
+			if (result === undefined) {
+				throw new Error(`Invalid duration: "${params.duration}"`);
+			}
+			return {
+				content: [{ type: "text", text: `${params.duration} = ${result} milliseconds` }],
+				details: {},
+			};
+		},
+	});
+}

package/examples/extensions/with-deps/package-lock.json

@@ -0,0 +1,31 @@
+{
+  "name": "pi-extension-with-deps",
+  "version": "0.74.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "pi-extension-with-deps",
+      "version": "0.74.0",
+      "dependencies": {
+        "ms": "^2.1.3"
+      },
+      "devDependencies": {
+        "@types/ms": "^2.1.0"
+      }
+    },
+    "node_modules/@types/ms": {
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz",
+      "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/ms": {
+      "version": "2.1.3",
+      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
+      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
+      "license": "MIT"
+    }
+  }
+}

package/examples/extensions/with-deps/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "pi-extension-with-deps",
+  "private": true,
+  "version": "0.74.0",
+  "type": "module",
+  "scripts": {
+    "clean": "echo 'nothing to clean'",
+    "build": "echo 'nothing to build'",
+    "check": "echo 'nothing to check'"
+  },
+  "pi": {
+    "extensions": [
+      "./index.ts"
+    ]
+  },
+  "dependencies": {
+    "ms": "^2.1.3"
+  },
+  "devDependencies": {
+    "@types/ms": "^2.1.0"
+  }
+}

package/examples/extensions/working-indicator.ts

@@ -0,0 +1,123 @@
+/**
+ * Working Indicator Extension
+ *
+ * Demonstrates `ctx.ui.setWorkingIndicator()` for customizing the inline
+ * working indicator shown while pi is streaming a response.
+ *
+ * Usage:
+ *   pi --extension examples/extensions/working-indicator.ts
+ *
+ * Commands:
+ *   /working-indicator           Show current mode
+ *   /working-indicator dot       Use a static dot indicator
+ *   /working-indicator pulse     Use a custom animated indicator
+ *   /working-indicator none      Hide the indicator entirely
+ *   /working-indicator spinner   Restore an animated spinner
+ *   /working-indicator reset     Restore pi's default spinner
+ */
+
+import type { ExtensionAPI, ExtensionContext, WorkingIndicatorOptions } from "@phi-code-admin/phi-code";
+
+type WorkingIndicatorMode = "dot" | "none" | "pulse" | "spinner" | "default";
+
+const SPINNER_FRAMES = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
+const PASTEL_RAINBOW = [
+	"\x1b[38;2;255;179;186m",
+	"\x1b[38;2;255;223;186m",
+	"\x1b[38;2;255;255;186m",
+	"\x1b[38;2;186;255;201m",
+	"\x1b[38;2;186;225;255m",
+	"\x1b[38;2;218;186;255m",
+];
+const RESET_FG = "\x1b[39m";
+const HIDDEN_INDICATOR: WorkingIndicatorOptions = {
+	frames: [],
+};
+
+function colorize(text: string, color: string): string {
+	return `${color}${text}${RESET_FG}`;
+}
+
+function getIndicator(mode: WorkingIndicatorMode): WorkingIndicatorOptions | undefined {
+	switch (mode) {
+		case "dot":
+			return {
+				frames: [colorize("●", PASTEL_RAINBOW[0])],
+			};
+		case "none":
+			return HIDDEN_INDICATOR;
+		case "pulse":
+			return {
+				frames: [
+					colorize("·", PASTEL_RAINBOW[0]),
+					colorize("•", PASTEL_RAINBOW[2]),
+					colorize("●", PASTEL_RAINBOW[4]),
+					colorize("•", PASTEL_RAINBOW[5]),
+				],
+				intervalMs: 120,
+			};
+		case "spinner":
+			return {
+				frames: SPINNER_FRAMES.map((frame, index) =>
+					colorize(frame, PASTEL_RAINBOW[index % PASTEL_RAINBOW.length]!),
+				),
+				intervalMs: 80,
+			};
+		case "default":
+			return undefined;
+	}
+}
+
+function describeMode(mode: WorkingIndicatorMode): string {
+	switch (mode) {
+		case "dot":
+			return "static dot";
+		case "none":
+			return "hidden";
+		case "pulse":
+			return "custom pulse";
+		case "spinner":
+			return "custom spinner";
+		case "default":
+			return "pi default spinner";
+	}
+}
+
+export default function (pi: ExtensionAPI) {
+	let mode: WorkingIndicatorMode = "spinner";
+
+	const applyIndicator = (ctx: ExtensionContext) => {
+		ctx.ui.setWorkingIndicator(getIndicator(mode));
+		ctx.ui.setStatus("working-indicator", ctx.ui.theme.fg("dim", `Indicator: ${describeMode(mode)}`));
+	};
+
+	pi.on("session_start", async (_event, ctx) => {
+		applyIndicator(ctx);
+	});
+
+	pi.registerCommand("working-indicator", {
+		description: "Set the streaming working indicator: dot, pulse, none, spinner, or reset.",
+		handler: async (args, ctx) => {
+			const nextMode = args.trim().toLowerCase();
+			if (!nextMode) {
+				ctx.ui.notify(`Working indicator: ${describeMode(mode)}`, "info");
+				return;
+			}
+
+			if (
+				nextMode !== "dot" &&
+				nextMode !== "none" &&
+				nextMode !== "pulse" &&
+				nextMode !== "spinner" &&
+				nextMode !== "reset"
+			) {
+				ctx.ui.notify("Usage: /working-indicator [dot|pulse|none|spinner|reset]", "error");
+				return;
+			}
+
+			mode = nextMode === "reset" ? "default" : nextMode;
+			applyIndicator(ctx);
+			ctx.ui.notify(`Working indicator set to: ${describeMode(mode)}`, "info");
+		},
+	});
+}

package/examples/extensions/working-message-test.ts

@@ -0,0 +1,25 @@
+/**
+ * Working Message Persistence Test
+ *
+ * Sets a custom working message and indicator on session start so you can
+ * verify they survive across loader recreations (e.g. between agent turns).
+ *
+ * Usage:
+ *   pi --extension examples/extensions/working-message-test.ts
+ *
+ * Then send a few messages in interactive mode. The working message should
+ * stay "Working... (custom)" with a brown dot indicator every time the
+ * loader appears, not revert to the default gray "Working...".
+ */
+
+import type { ExtensionAPI } from "@phi-code-admin/phi-code";
+
+const CUSTOM_MESSAGE = "\x1b[38;2;155;86;63mWorking... (custom)\x1b[39m";
+const CUSTOM_INDICATOR = { frames: ["\x1b[38;2;155;86;63m●\x1b[39m"] };
+
+export default function (pi: ExtensionAPI) {
+	pi.on("session_start", async (_event, ctx) => {
+		ctx.ui.setWorkingMessage(CUSTOM_MESSAGE);
+		ctx.ui.setWorkingIndicator(CUSTOM_INDICATOR);
+	});
+}