@nedleeds/pi-compact-ui 0.1.0 → 0.2.0

package/README.md

@@ -1,13 +1,17 @@
 # pi-compact-ui
 
-Compact, expandable rendering for pi's built-in `read`, `write`, `edit`, and `bash` tools, bundled with a polished GitHub Dark theme.
+Compact, expandable rendering for all of Pi's built-in tools, bundled with a polished GitHub Dark theme.
 
 Designed for a focused, low-noise terminal workflow.
 
-![Spinner and duration indicators](https://raw.githubusercontent.com/nedleeds/pi-compact-ui/main/assets/spinner-status.gif)
+![Built-in tool support](https://raw.githubusercontent.com/nedleeds/pi-compact-ui/main/assets/built-in-tool-support.png)
 
 ## Demo
 
+**Spinner and status** – track active execution and see duration-aware completion indicators.
+
+![Spinner and duration indicators](https://raw.githubusercontent.com/nedleeds/pi-compact-ui/main/assets/spinner-status.gif)
+
 **Keyboard expansion** – press `Ctrl+O` to cycle through detail levels.
 
 ![Ctrl+O expansion](https://raw.githubusercontent.com/nedleeds/pi-compact-ui/main/assets/keyboard-expand.gif)
@@ -18,7 +22,8 @@ Designed for a focused, low-noise terminal workflow.
 
 ## Features
 
-- Compact one-line tool calls
+- Compact one-line rendering for configurable built-in tools
+- Supports `read`, `write`, `edit`, `bash`, `powershell`, `grep`, `find`, and `ls`
 - Click or `Ctrl+O` to cycle through available detail levels
 - Skips argument and output levels that contain no additional information
 - Animated, configurable tool spinner
@@ -28,6 +33,21 @@ Designed for a focused, low-noise terminal workflow.
 - GitHub Dark theme with distinct tool, output, success, and error colors
 - No Nerd Font requirement
 
+## Supported tools
+
+| Tool | Purpose | Compact by default |
+| --- | --- | :---: |
+| `read` | Read files and images | Yes |
+| `write` | Create or overwrite files | Yes |
+| `edit` | Apply exact text replacements with clean diffs | Yes |
+| `bash` | Run shell commands | Yes |
+| `grep` | Search file contents | Opt-in |
+| `find` | Find files by glob pattern | Opt-in |
+| `ls` | List directory contents | Opt-in |
+| `powershell` | Run PowerShell commands | Opt-in |
+
+Enable opt-in tools with the [`tools` configuration](#configuration). PowerShell is intended for Windows; the other seven tools are demonstrated above on macOS.
+
 ## Requirements
 
 - pi `0.85.1` or newer is recommended
@@ -85,6 +105,7 @@ Default configuration:
 ```json
 {
   "$schema": "https://raw.githubusercontent.com/nedleeds/pi-compact-ui/main/schemas/compact-tools.schema.json",
+  "tools": ["read", "write", "edit", "bash"],
   "previewLines": 10,
   "spinner": {
     "frames": ["◐", "◓", "◑", "◒"],
@@ -99,6 +120,16 @@ Default configuration:
 }
 ```
 
+`tools` selects which built-in definitions receive compact rendering. Omitted tools retain Pi's default renderer. The array replaces, rather than extends, the previous configuration layer. To enable every Unix-compatible tool:
+
+```json
+{
+  "tools": ["read", "write", "edit", "bash", "grep", "find", "ls"]
+}
+```
+
+`powershell` is also supported and can be selected explicitly on Windows. Unsupported names are ignored with a warning.
+
 `durationIndicators` must use ascending `underMs` values. The final entry must omit `underMs` and acts as the fallback.
 
 ## Expansion levels
@@ -119,7 +150,7 @@ summary → diff → summary
 
 ## Compatibility and limitations
 
-- The package overrides pi's built-in `read`, `write`, `edit`, and `bash` definitions while preserving their execution behavior and metadata.
+- The package overrides only the built-in definitions selected by `tools`, while preserving their execution behavior and metadata.
 - Another extension overriding the same tool names may conflict depending on extension load order.
 - Tools registered by other extensions are not modified.
 - Duration is measured from the first execution render and is intended as a UI estimate.

package/examples/compact-tools.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/nedleeds/pi-compact-ui/main/schemas/compact-tools.schema.json",
+  "tools": ["read", "write", "edit", "bash", "grep", "find", "ls"],
   "previewLines": 10,
   "spinner": {
     "frames": ["◐", "◓", "◑", "◒"],

package/extensions/compact-tools.ts

@@ -15,6 +15,10 @@ import {
 	CONFIG_DIR_NAME,
 	createBashToolDefinition,
 	createEditToolDefinition,
+	createFindToolDefinition,
+	createGrepToolDefinition,
+	createLsToolDefinition,
+	createPowerShellToolDefinition,
 	createReadToolDefinition,
 	createWriteToolDefinition,
 	getAgentDir,
@@ -24,6 +28,10 @@ import { Container, Text, visibleWidth } from "@earendil-works/pi-tui";
 
 const MAX_LEVEL = 3;
 const CONFIG_FILE = "compact-tools.json";
+const SUPPORTED_TOOLS = ["read", "write", "edit", "bash", "powershell", "grep", "find", "ls"] as const;
+const SUPPORTED_TOOL_SET = new Set<string>(SUPPORTED_TOOLS);
+
+type CompactToolName = (typeof SUPPORTED_TOOLS)[number];
 
 export interface DurationIndicatorConfig {
 	underMs?: number;
@@ -31,6 +39,7 @@ export interface DurationIndicatorConfig {
 }
 
 export interface CompactToolsConfig {
+	tools: CompactToolName[];
 	previewLines: number;
 	spinner: {
 		frames: string[];
@@ -40,6 +49,7 @@ export interface CompactToolsConfig {
 }
 
 export const DEFAULT_CONFIG: CompactToolsConfig = {
+	tools: ["read", "write", "edit", "bash"],
 	previewLines: 10,
 	spinner: {
 		frames: ["◐", "◓", "◑", "◒"],
@@ -49,11 +59,12 @@ export const DEFAULT_CONFIG: CompactToolsConfig = {
 		{ underMs: 1_000, icon: "⚡️" },
 		{ underMs: 10_000, icon: "🚀" },
 		{ underMs: 30_000, icon: "🔥" },
-		{ icon: "☕" },
+		{ icon: "⏳" },
 	],
 };
 
 let config = DEFAULT_CONFIG;
+const registeredCompactTools = new Set<CompactToolName>();
 
 interface RowState {
 	level?: number;
@@ -92,6 +103,17 @@ function isNonEmptyStringArray(value: unknown): value is string[] {
 	return Array.isArray(value) && value.length > 0 && value.every((item) => typeof item === "string" && item.length > 0);
 }
 
+function parseTools(value: unknown, path: string): CompactToolName[] | undefined {
+	if (!Array.isArray(value)) {
+		warnConfig(path, "tools must be an array; using previous values");
+		return undefined;
+	}
+	const valid = value.filter((item): item is CompactToolName => typeof item === "string" && SUPPORTED_TOOL_SET.has(item));
+	const invalid = value.filter((item) => typeof item !== "string" || !SUPPORTED_TOOL_SET.has(item));
+	if (invalid.length > 0) warnConfig(path, `ignoring unsupported tools: ${invalid.map(String).join(", ")}`);
+	return [...new Set(valid)];
+}
+
 function parseDurationIndicators(value: unknown): DurationIndicatorConfig[] | undefined {
 	if (!Array.isArray(value) || value.length === 0) return undefined;
 	const rules: DurationIndicatorConfig[] = [];
@@ -114,6 +136,7 @@ function mergeConfig(base: CompactToolsConfig, value: unknown, path: string): Co
 		warnConfig(path, "expected a JSON object; using previous values");
 		return base;
 	}
+	const tools = value.tools === undefined ? base.tools : (parseTools(value.tools, path) ?? base.tools);
 	const previewValue = value.previewLines;
 	const validPreviewLines = isIntegerInRange(previewValue, 1, 1_000);
 	const previewLines = validPreviewLines ? previewValue : base.previewLines;
@@ -125,7 +148,7 @@ function mergeConfig(base: CompactToolsConfig, value: unknown, path: string): Co
 	if (value.durationIndicators !== undefined && durationIndicators === base.durationIndicators) {
 		warnConfig(path, "invalid durationIndicators; using previous values");
 	}
-	return { previewLines, spinner, durationIndicators };
+	return { tools, previewLines, spinner, durationIndicators };
 }
 
 function parseSpinnerConfig(
@@ -339,10 +362,19 @@ function getPathArg(args: ToolArgs): string {
 	return typeof value === "string" ? firstLine(value) : "";
 }
 
+function getCallDetails(name: string, args: ToolArgs): string {
+	const path = getPathArg(args) || (name === "grep" || name === "find" || name === "ls" ? "." : "");
+	const pattern = typeof args.pattern === "string" ? firstLine(args.pattern) : "…";
+	if (name === "grep") return `/${pattern}/ in ${path}`;
+	if (name === "find") return `${pattern} in ${path}`;
+	return path;
+}
+
 function getFileArgumentDetails(name: string, args: ToolArgs): ToolArgs {
 	if (name === "edit") return {};
 	const omitted = new Set(["path", "file_path"]);
 	if (name === "write") omitted.add("content");
+	if (name === "grep" || name === "find") omitted.add("pattern");
 	return Object.fromEntries(Object.entries(args).filter(([key, value]) => !omitted.has(key) && value !== undefined));
 }
 
@@ -374,7 +406,9 @@ function callOriginalEditResult(
 }
 
 function getFileOutput(name: string, args: ToolArgs, result: AgentToolResult<unknown>, isError: boolean): string {
-	if (isError || name === "read") return getTextResult(result);
+	if (isError || name === "read" || name === "grep" || name === "find" || name === "ls") {
+		return getTextResult(result);
+	}
 	if (name === "write") return String(args.content ?? "");
 	return "";
 }
@@ -388,11 +422,11 @@ function renderFileCall(
 	const running = ctx.executionStarted && ctx.isPartial;
 	const state = syncRow(ctx, running);
 	const level = advanceLevel(state, ctx.expanded);
-	const path = getPathArg(args);
+	const callDetails = getCallDetails(definition.name, args);
 	const argumentDetails = getFileArgumentDetails(definition.name, args);
 	let text = `${renderIndicator(theme, state, running, ctx.isError, ctx.isPartial && !ctx.executionStarted)} `;
 	text += theme.fg("toolTitle", theme.bold(definition.name));
-	if (path) text += ` ${theme.fg("toolOutput", path)}`;
+	if (callDetails) text += ` ${theme.fg("toolOutput", callDetails)}`;
 
 	const container = new Container();
 	container.addChild(new Text(text, 1, 0));
@@ -463,14 +497,19 @@ function registerFileTool(pi: ExtensionAPI, definition: BuiltInDefinition): void
 	pi.registerTool(tool as ToolDefinition<any, any, RowState>);
 }
 
-function renderBashCall(args: BashToolInput, theme: Theme, ctx: RenderContext<BashToolInput>): Text {
+function renderShellCall(
+	name: "bash" | "powershell",
+	args: BashToolInput,
+	theme: Theme,
+	ctx: RenderContext<BashToolInput>,
+): Text {
 	const running = ctx.executionStarted && ctx.isPartial;
 	const state = syncRow(ctx, running);
 	const level = advanceLevel(state, ctx.expanded);
 	const command = args.command ?? "";
 	const displayedCommand = (level >= 1 ? command : firstLine(command)) || "…";
 	let text = `${renderIndicator(theme, state, running, ctx.isError, ctx.isPartial && !ctx.executionStarted)} `;
-	text += `${theme.fg("toolTitle", theme.bold("bash"))} ${theme.fg("toolOutput", displayedCommand)}`;
+	text += `${theme.fg("toolTitle", theme.bold(name))} ${theme.fg("toolOutput", displayedCommand)}`;
 	if (level >= 1 && args.timeout) text += theme.fg("dim", ` (timeout: ${args.timeout}s)`);
 	return new Text(text, 1, 0);
 }
@@ -496,21 +535,40 @@ function renderBashResult(
 	return container;
 }
 
-function registerBashTool(pi: ExtensionAPI, cwd: string): void {
-	const original = createBashToolDefinition(cwd);
-	pi.registerTool<typeof original.parameters, BashToolDetails | undefined, RowState>({
-		...original,
+function createBuiltInDefinition(name: CompactToolName, cwd: string): BuiltInDefinition {
+	switch (name) {
+		case "read": return createReadToolDefinition(cwd);
+		case "write": return createWriteToolDefinition(cwd);
+		case "edit": return createEditToolDefinition(cwd);
+		case "bash": return createBashToolDefinition(cwd);
+		case "powershell": return createPowerShellToolDefinition(cwd);
+		case "grep": return createGrepToolDefinition(cwd);
+		case "find": return createFindToolDefinition(cwd);
+		case "ls": return createLsToolDefinition(cwd);
+	}
+}
+
+function registerShellTool(pi: ExtensionAPI, definition: BuiltInDefinition): void {
+	pi.registerTool({
+		...definition,
 		renderShell: "self",
-		renderCall: renderBashCall,
+		renderCall: (args: BashToolInput, theme: Theme, ctx: RenderContext<BashToolInput>) =>
+			renderShellCall(definition.name as "bash" | "powershell", args, theme, ctx),
 		renderResult: renderBashResult,
-	});
+	} as ToolDefinition<any, BashToolDetails | undefined, RowState>);
 }
 
 function registerBuiltInTools(pi: ExtensionAPI, cwd: string): void {
-	registerFileTool(pi, createReadToolDefinition(cwd));
-	registerFileTool(pi, createEditToolDefinition(cwd));
-	registerFileTool(pi, createWriteToolDefinition(cwd));
-	registerBashTool(pi, cwd);
+	for (const name of registeredCompactTools) {
+		if (!config.tools.includes(name)) pi.registerTool(createBuiltInDefinition(name, cwd));
+	}
+	registeredCompactTools.clear();
+	for (const name of config.tools) {
+		const definition = createBuiltInDefinition(name, cwd);
+		if (name === "bash" || name === "powershell") registerShellTool(pi, definition);
+		else registerFileTool(pi, definition);
+		registeredCompactTools.add(name);
+	}
 }
 
 function applyConfig(pi: ExtensionAPI, cwd: string, projectTrusted: boolean): void {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nedleeds/pi-compact-ui",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Compact, expandable UI for pi's built-in tools, bundled with a polished GitHub Dark theme.",
   "type": "module",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "themes": [
       "./themes/github-dark-pro.json"
     ],
-    "image": "https://raw.githubusercontent.com/nedleeds/pi-compact-ui/main/assets/spinner-status.gif"
+    "image": "https://raw.githubusercontent.com/nedleeds/pi-compact-ui/main/assets/built-in-tool-support.png"
   },
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": "*",

package/schemas/compact-tools.schema.json

@@ -8,6 +8,16 @@
     "$schema": {
       "type": "string"
     },
+    "tools": {
+      "description": "Built-in tools that use compact rendering. Omitted tools keep Pi's default renderer.",
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "enum": ["read", "write", "edit", "bash", "powershell", "grep", "find", "ls"]
+      },
+      "default": ["read", "write", "edit", "bash"]
+    },
     "previewLines": {
       "description": "Number of output lines shown before the full-output expansion level.",
       "type": "integer",