@mariozechner/pi-coding-agent 0.33.0 → 0.34.0

package/examples/hooks/pirate.ts

@@ -0,0 +1,44 @@
+/**
+ * Pirate Hook
+ *
+ * Demonstrates using systemPromptAppend in before_agent_start to dynamically
+ * modify the system prompt based on hook state.
+ *
+ * Usage:
+ * 1. Copy this file to ~/.pi/agent/hooks/ or your project's .pi/hooks/
+ * 2. Use /pirate to toggle pirate mode
+ * 3. When enabled, the agent will respond like a pirate
+ */
+
+import type { HookAPI } from "@mariozechner/pi-coding-agent/hooks";
+
+export default function pirateHook(pi: HookAPI) {
+	let pirateMode = false;
+
+	// Register /pirate command to toggle pirate mode
+	pi.registerCommand("pirate", {
+		description: "Toggle pirate mode (agent speaks like a pirate)",
+		handler: async (_args, ctx) => {
+			pirateMode = !pirateMode;
+			ctx.ui.notify(pirateMode ? "Arrr! Pirate mode enabled!" : "Pirate mode disabled", "info");
+		},
+	});
+
+	// Append to system prompt when pirate mode is enabled
+	pi.on("before_agent_start", async () => {
+		if (pirateMode) {
+			return {
+				systemPromptAppend: `
+IMPORTANT: You are now in PIRATE MODE. You must:
+- Speak like a stereotypical pirate in all responses
+- Use phrases like "Arrr!", "Ahoy!", "Shiver me timbers!", "Avast!", "Ye scurvy dog!"
+- Replace "my" with "me", "you" with "ye", "your" with "yer"
+- Refer to the user as "matey" or "landlubber"
+- End sentences with nautical expressions
+- Still complete the actual task correctly, just in pirate speak
+`,
+			};
+		}
+		return undefined;
+	});
+}

package/examples/hooks/plan-mode.ts

@@ -0,0 +1,548 @@
+/**
+ * Plan Mode Hook
+ *
+ * Provides a Claude Code-style "plan mode" for safe code exploration.
+ * When enabled, the agent can only use read-only tools and cannot modify files.
+ *
+ * Features:
+ * - /plan command to toggle plan mode
+ * - In plan mode: only read, bash (read-only), grep, find, ls are available
+ * - Injects system context telling the agent about the restrictions
+ * - After each agent response, prompts to execute the plan or continue planning
+ * - Shows "plan" indicator in footer when active
+ * - Extracts todo list from plan and tracks progress during execution
+ * - Uses ID-based tracking: agent outputs [DONE:id] to mark steps complete
+ *
+ * Usage:
+ * 1. Copy this file to ~/.pi/agent/hooks/ or your project's .pi/hooks/
+ * 2. Use /plan to toggle plan mode on/off
+ * 3. Or start in plan mode with --plan flag
+ */
+
+import type { HookAPI, HookContext } from "@mariozechner/pi-coding-agent/hooks";
+import { Key } from "@mariozechner/pi-tui";
+
+// Read-only tools for plan mode
+const PLAN_MODE_TOOLS = ["read", "bash", "grep", "find", "ls"];
+
+// Full set of tools for normal mode
+const NORMAL_MODE_TOOLS = ["read", "bash", "edit", "write"];
+
+// Patterns for destructive bash commands that should be blocked in plan mode
+const DESTRUCTIVE_PATTERNS = [
+	/\brm\b/i,
+	/\brmdir\b/i,
+	/\bmv\b/i,
+	/\bcp\b/i,
+	/\bmkdir\b/i,
+	/\btouch\b/i,
+	/\bchmod\b/i,
+	/\bchown\b/i,
+	/\bchgrp\b/i,
+	/\bln\b/i,
+	/\btee\b/i,
+	/\btruncate\b/i,
+	/\bdd\b/i,
+	/\bshred\b/i,
+	/[^<]>(?!>)/,
+	/>>/,
+	/\bnpm\s+(install|uninstall|update|ci|link|publish)/i,
+	/\byarn\s+(add|remove|install|publish)/i,
+	/\bpnpm\s+(add|remove|install|publish)/i,
+	/\bpip\s+(install|uninstall)/i,
+	/\bapt(-get)?\s+(install|remove|purge|update|upgrade)/i,
+	/\bbrew\s+(install|uninstall|upgrade)/i,
+	/\bgit\s+(add|commit|push|pull|merge|rebase|reset|checkout\s+-b|branch\s+-[dD]|stash|cherry-pick|revert|tag|init|clone)/i,
+	/\bsudo\b/i,
+	/\bsu\b/i,
+	/\bkill\b/i,
+	/\bpkill\b/i,
+	/\bkillall\b/i,
+	/\breboot\b/i,
+	/\bshutdown\b/i,
+	/\bsystemctl\s+(start|stop|restart|enable|disable)/i,
+	/\bservice\s+\S+\s+(start|stop|restart)/i,
+	/\b(vim?|nano|emacs|code|subl)\b/i,
+];
+
+// Read-only commands that are always safe
+const SAFE_COMMANDS = [
+	/^\s*cat\b/,
+	/^\s*head\b/,
+	/^\s*tail\b/,
+	/^\s*less\b/,
+	/^\s*more\b/,
+	/^\s*grep\b/,
+	/^\s*find\b/,
+	/^\s*ls\b/,
+	/^\s*pwd\b/,
+	/^\s*echo\b/,
+	/^\s*printf\b/,
+	/^\s*wc\b/,
+	/^\s*sort\b/,
+	/^\s*uniq\b/,
+	/^\s*diff\b/,
+	/^\s*file\b/,
+	/^\s*stat\b/,
+	/^\s*du\b/,
+	/^\s*df\b/,
+	/^\s*tree\b/,
+	/^\s*which\b/,
+	/^\s*whereis\b/,
+	/^\s*type\b/,
+	/^\s*env\b/,
+	/^\s*printenv\b/,
+	/^\s*uname\b/,
+	/^\s*whoami\b/,
+	/^\s*id\b/,
+	/^\s*date\b/,
+	/^\s*cal\b/,
+	/^\s*uptime\b/,
+	/^\s*ps\b/,
+	/^\s*top\b/,
+	/^\s*htop\b/,
+	/^\s*free\b/,
+	/^\s*git\s+(status|log|diff|show|branch|remote|config\s+--get)/i,
+	/^\s*git\s+ls-/i,
+	/^\s*npm\s+(list|ls|view|info|search|outdated|audit)/i,
+	/^\s*yarn\s+(list|info|why|audit)/i,
+	/^\s*node\s+--version/i,
+	/^\s*python\s+--version/i,
+	/^\s*curl\s/i,
+	/^\s*wget\s+-O\s*-/i,
+	/^\s*jq\b/,
+	/^\s*sed\s+-n/i,
+	/^\s*awk\b/,
+	/^\s*rg\b/,
+	/^\s*fd\b/,
+	/^\s*bat\b/,
+	/^\s*exa\b/,
+];
+
+function isSafeCommand(command: string): boolean {
+	if (SAFE_COMMANDS.some((pattern) => pattern.test(command))) {
+		if (!DESTRUCTIVE_PATTERNS.some((pattern) => pattern.test(command))) {
+			return true;
+		}
+	}
+	if (DESTRUCTIVE_PATTERNS.some((pattern) => pattern.test(command))) {
+		return false;
+	}
+	return true;
+}
+
+// Todo item with step number
+interface TodoItem {
+	step: number;
+	text: string;
+	completed: boolean;
+}
+
+/**
+ * Clean up extracted step text for display.
+ */
+function cleanStepText(text: string): string {
+	let cleaned = text
+		// Remove markdown bold/italic
+		.replace(/\*{1,2}([^*]+)\*{1,2}/g, "$1")
+		// Remove markdown code
+		.replace(/`([^`]+)`/g, "$1")
+		// Remove leading action words that are redundant
+		.replace(
+			/^(Use|Run|Execute|Create|Write|Read|Check|Verify|Update|Modify|Add|Remove|Delete|Install)\s+(the\s+)?/i,
+			"",
+		)
+		// Clean up extra whitespace
+		.replace(/\s+/g, " ")
+		.trim();
+
+	// Capitalize first letter
+	if (cleaned.length > 0) {
+		cleaned = cleaned.charAt(0).toUpperCase() + cleaned.slice(1);
+	}
+
+	// Truncate if too long
+	if (cleaned.length > 50) {
+		cleaned = `${cleaned.slice(0, 47)}...`;
+	}
+
+	return cleaned;
+}
+
+/**
+ * Extract todo items from assistant message.
+ */
+function extractTodoItems(message: string): TodoItem[] {
+	const items: TodoItem[] = [];
+
+	// Match numbered lists: "1. Task" or "1) Task" - also handle **bold** prefixes
+	const numberedPattern = /^\s*(\d+)[.)]\s+\*{0,2}([^*\n]+)/gm;
+	for (const match of message.matchAll(numberedPattern)) {
+		let text = match[2].trim();
+		text = text.replace(/\*{1,2}$/, "").trim();
+		// Skip if too short or looks like code/command
+		if (text.length > 5 && !text.startsWith("`") && !text.startsWith("/") && !text.startsWith("-")) {
+			const cleaned = cleanStepText(text);
+			if (cleaned.length > 3) {
+				items.push({ step: items.length + 1, text: cleaned, completed: false });
+			}
+		}
+	}
+
+	// If no numbered items, try bullet points
+	if (items.length === 0) {
+		const stepPattern = /^\s*[-*]\s*(?:Step\s*\d+[:.])?\s*\*{0,2}([^*\n]+)/gim;
+		for (const match of message.matchAll(stepPattern)) {
+			let text = match[1].trim();
+			text = text.replace(/\*{1,2}$/, "").trim();
+			if (text.length > 10 && !text.startsWith("`")) {
+				const cleaned = cleanStepText(text);
+				if (cleaned.length > 3) {
+					items.push({ step: items.length + 1, text: cleaned, completed: false });
+				}
+			}
+		}
+	}
+
+	return items;
+}
+
+export default function planModeHook(pi: HookAPI) {
+	let planModeEnabled = false;
+	let toolsCalledThisTurn = false;
+	let executionMode = false;
+	let todoItems: TodoItem[] = [];
+
+	// Register --plan CLI flag
+	pi.registerFlag("plan", {
+		description: "Start in plan mode (read-only exploration)",
+		type: "boolean",
+		default: false,
+	});
+
+	// Helper to update status displays
+	function updateStatus(ctx: HookContext) {
+		if (executionMode && todoItems.length > 0) {
+			const completed = todoItems.filter((t) => t.completed).length;
+			ctx.ui.setStatus("plan-mode", ctx.ui.theme.fg("accent", `📋 ${completed}/${todoItems.length}`));
+		} else if (planModeEnabled) {
+			ctx.ui.setStatus("plan-mode", ctx.ui.theme.fg("warning", "⏸ plan"));
+		} else {
+			ctx.ui.setStatus("plan-mode", undefined);
+		}
+
+		// Show widget during execution (no IDs shown to user)
+		if (executionMode && todoItems.length > 0) {
+			const lines: string[] = [];
+			for (const item of todoItems) {
+				if (item.completed) {
+					lines.push(
+						ctx.ui.theme.fg("success", "☑ ") + ctx.ui.theme.fg("muted", ctx.ui.theme.strikethrough(item.text)),
+					);
+				} else {
+					lines.push(ctx.ui.theme.fg("muted", "☐ ") + item.text);
+				}
+			}
+			ctx.ui.setWidget("plan-todos", lines);
+		} else {
+			ctx.ui.setWidget("plan-todos", undefined);
+		}
+	}
+
+	function togglePlanMode(ctx: HookContext) {
+		planModeEnabled = !planModeEnabled;
+		executionMode = false;
+		todoItems = [];
+
+		if (planModeEnabled) {
+			pi.setActiveTools(PLAN_MODE_TOOLS);
+			ctx.ui.notify(`Plan mode enabled. Tools: ${PLAN_MODE_TOOLS.join(", ")}`);
+		} else {
+			pi.setActiveTools(NORMAL_MODE_TOOLS);
+			ctx.ui.notify("Plan mode disabled. Full access restored.");
+		}
+		updateStatus(ctx);
+	}
+
+	// Register /plan command
+	pi.registerCommand("plan", {
+		description: "Toggle plan mode (read-only exploration)",
+		handler: async (_args, ctx) => {
+			togglePlanMode(ctx);
+		},
+	});
+
+	// Register /todos command
+	pi.registerCommand("todos", {
+		description: "Show current plan todo list",
+		handler: async (_args, ctx) => {
+			if (todoItems.length === 0) {
+				ctx.ui.notify("No todos. Create a plan first with /plan", "info");
+				return;
+			}
+
+			const todoList = todoItems
+				.map((item, i) => {
+					const checkbox = item.completed ? "✓" : "○";
+					return `${i + 1}. ${checkbox} ${item.text}`;
+				})
+				.join("\n");
+
+			ctx.ui.notify(`Plan Progress:\n${todoList}`, "info");
+		},
+	});
+
+	// Register Shift+P shortcut
+	pi.registerShortcut(Key.shift("p"), {
+		description: "Toggle plan mode",
+		handler: async (ctx) => {
+			togglePlanMode(ctx);
+		},
+	});
+
+	// Block destructive bash in plan mode
+	pi.on("tool_call", async (event) => {
+		if (!planModeEnabled) return;
+		if (event.toolName !== "bash") return;
+
+		const command = event.input.command as string;
+		if (!isSafeCommand(command)) {
+			return {
+				block: true,
+				reason: `Plan mode: destructive command blocked. Use /plan to disable plan mode first.\nCommand: ${command}`,
+			};
+		}
+	});
+
+	// Track step completion based on tool results
+	pi.on("tool_result", async (_event, ctx) => {
+		toolsCalledThisTurn = true;
+
+		if (!executionMode || todoItems.length === 0) return;
+
+		// Mark the first uncompleted step as done when any tool succeeds
+		const nextStep = todoItems.find((t) => !t.completed);
+		if (nextStep) {
+			nextStep.completed = true;
+			updateStatus(ctx);
+		}
+	});
+
+	// Filter out stale plan mode context messages from LLM context
+	// This ensures the agent only sees the CURRENT state (plan mode on/off)
+	pi.on("context", async (event) => {
+		// Only filter when NOT in plan mode (i.e., when executing)
+		if (planModeEnabled) {
+			return;
+		}
+
+		// Remove any previous plan-mode-context messages
+		const _beforeCount = event.messages.length;
+		const filtered = event.messages.filter((m) => {
+			if (m.role === "user" && Array.isArray(m.content)) {
+				const hasOldContext = m.content.some((c) => c.type === "text" && c.text.includes("[PLAN MODE ACTIVE]"));
+				if (hasOldContext) {
+					return false;
+				}
+			}
+			return true;
+		});
+		return { messages: filtered };
+	});
+
+	// Inject plan mode context
+	pi.on("before_agent_start", async () => {
+		if (!planModeEnabled && !executionMode) {
+			return;
+		}
+
+		if (planModeEnabled) {
+			return {
+				message: {
+					customType: "plan-mode-context",
+					content: `[PLAN MODE ACTIVE]
+You are in plan mode - a read-only exploration mode for safe code analysis.
+
+Restrictions:
+- You can only use: read, bash, grep, find, ls
+- You CANNOT use: edit, write (file modifications are disabled)
+- Bash is restricted to READ-ONLY commands
+- Focus on analysis, planning, and understanding the codebase
+
+Create a detailed numbered plan:
+1. First step description
+2. Second step description
+...
+
+Do NOT attempt to make changes - just describe what you would do.`,
+					display: false,
+				},
+			};
+		}
+
+		if (executionMode && todoItems.length > 0) {
+			const remaining = todoItems.filter((t) => !t.completed);
+			const todoList = remaining.map((t) => `${t.step}. ${t.text}`).join("\n");
+			return {
+				message: {
+					customType: "plan-execution-context",
+					content: `[EXECUTING PLAN - Full tool access enabled]
+
+Remaining steps:
+${todoList}
+
+Execute each step in order.`,
+					display: false,
+				},
+			};
+		}
+	});
+
+	// After agent finishes
+	pi.on("agent_end", async (event, ctx) => {
+		// In execution mode, check if all steps complete
+		if (executionMode && todoItems.length > 0) {
+			const allComplete = todoItems.every((t) => t.completed);
+			if (allComplete) {
+				// Show final completed list in chat
+				const completedList = todoItems.map((t) => `~~${t.text}~~`).join("\n");
+				pi.sendMessage(
+					{
+						customType: "plan-complete",
+						content: `**Plan Complete!** ✓\n\n${completedList}`,
+						display: true,
+					},
+					{ triggerTurn: false },
+				);
+
+				executionMode = false;
+				todoItems = [];
+				pi.setActiveTools(NORMAL_MODE_TOOLS);
+				updateStatus(ctx);
+			}
+			return;
+		}
+
+		if (!planModeEnabled) return;
+		if (!ctx.hasUI) return;
+
+		// Extract todos from last message
+		const messages = event.messages;
+		const lastAssistant = [...messages].reverse().find((m) => m.role === "assistant");
+		if (lastAssistant && Array.isArray(lastAssistant.content)) {
+			const textContent = lastAssistant.content
+				.filter((block): block is { type: "text"; text: string } => block.type === "text")
+				.map((block) => block.text)
+				.join("\n");
+
+			if (textContent) {
+				const extracted = extractTodoItems(textContent);
+				if (extracted.length > 0) {
+					todoItems = extracted;
+				}
+			}
+		}
+
+		const hasTodos = todoItems.length > 0;
+
+		// Show todo list in chat (no IDs shown to user, just numbered)
+		if (hasTodos) {
+			const todoListText = todoItems.map((t, i) => `${i + 1}. ☐ ${t.text}`).join("\n");
+			pi.sendMessage(
+				{
+					customType: "plan-todo-list",
+					content: `**Plan Steps (${todoItems.length}):**\n\n${todoListText}`,
+					display: true,
+				},
+				{ triggerTurn: false },
+			);
+		}
+
+		const choice = await ctx.ui.select("Plan mode - what next?", [
+			hasTodos ? "Execute the plan (track progress)" : "Execute the plan",
+			"Stay in plan mode",
+			"Refine the plan",
+		]);
+
+		if (choice?.startsWith("Execute")) {
+			planModeEnabled = false;
+			executionMode = hasTodos;
+			pi.setActiveTools(NORMAL_MODE_TOOLS);
+			updateStatus(ctx);
+
+			// Simple execution message - context event filters old plan mode messages
+			// and before_agent_start injects fresh execution context with IDs
+			const execMessage = hasTodos
+				? `Execute the plan. Start with: ${todoItems[0].text}`
+				: "Execute the plan you just created.";
+
+			pi.sendMessage(
+				{
+					customType: "plan-mode-execute",
+					content: execMessage,
+					display: true,
+				},
+				{ triggerTurn: true },
+			);
+		} else if (choice === "Refine the plan") {
+			const refinement = await ctx.ui.input("What should be refined?");
+			if (refinement) {
+				ctx.ui.setEditorText(refinement);
+			}
+		}
+	});
+
+	// Initialize state on session start
+	pi.on("session_start", async (_event, ctx) => {
+		if (pi.getFlag("plan") === true) {
+			planModeEnabled = true;
+		}
+
+		const entries = ctx.sessionManager.getEntries();
+		const planModeEntry = entries
+			.filter((e: { type: string; customType?: string }) => e.type === "custom" && e.customType === "plan-mode")
+			.pop() as { data?: { enabled: boolean; todos?: TodoItem[]; executing?: boolean } } | undefined;
+
+		if (planModeEntry?.data) {
+			if (planModeEntry.data.enabled !== undefined) {
+				planModeEnabled = planModeEntry.data.enabled;
+			}
+			if (planModeEntry.data.todos) {
+				todoItems = planModeEntry.data.todos;
+			}
+			if (planModeEntry.data.executing) {
+				executionMode = planModeEntry.data.executing;
+			}
+		}
+
+		if (planModeEnabled) {
+			pi.setActiveTools(PLAN_MODE_TOOLS);
+		}
+		updateStatus(ctx);
+	});
+
+	// Reset tool tracking at start of each turn and persist state
+	pi.on("turn_start", async () => {
+		toolsCalledThisTurn = false;
+		pi.appendEntry("plan-mode", {
+			enabled: planModeEnabled,
+			todos: todoItems,
+			executing: executionMode,
+		});
+	});
+
+	// Handle non-tool turns (e.g., analysis, explanation steps)
+	pi.on("turn_end", async (_event, ctx) => {
+		if (!executionMode || todoItems.length === 0) return;
+
+		// If no tools were called this turn, the agent was doing analysis/explanation
+		// Mark the next uncompleted step as done
+		if (!toolsCalledThisTurn) {
+			const nextStep = todoItems.find((t) => !t.completed);
+			if (nextStep) {
+				nextStep.completed = true;
+				updateStatus(ctx);
+			}
+		}
+	});
+}