@mariozechner/pi-coding-agent 0.25.4 → 0.26.1

package/examples/README.md

@@ -0,0 +1,29 @@
+# Examples
+
+Example code for pi-coding-agent.
+
+## Directories
+
+### [sdk/](sdk/)
+Programmatic usage via `createAgentSession()`. Shows how to customize models, prompts, tools, hooks, and session management.
+
+### [hooks/](hooks/)
+Example hooks for intercepting tool calls, adding safety gates, and integrating with external systems.
+
+### [custom-tools/](custom-tools/)
+Example custom tools that extend the agent's capabilities.
+
+## Running Examples
+
+```bash
+cd packages/coding-agent
+npx tsx examples/sdk/01-minimal.ts
+npx tsx examples/hooks/permission-gate.ts
+```
+
+## Documentation
+
+- [SDK Reference](sdk/README.md)
+- [Hooks Documentation](../docs/hooks.md)
+- [Custom Tools Documentation](../docs/custom-tools.md)
+- [Skills Documentation](../docs/skills.md)

package/examples/sdk/01-minimal.ts

@@ -0,0 +1,22 @@
+/**
+ * Minimal SDK Usage
+ *
+ * Uses all defaults: discovers skills, hooks, tools, context files
+ * from cwd and ~/.pi/agent. Model chosen from settings or first available.
+ */
+
+import { createAgentSession } from "../../src/index.js";
+
+const { session } = await createAgentSession();
+
+session.subscribe((event) => {
+	if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+		process.stdout.write(event.assistantMessageEvent.delta);
+	}
+});
+
+await session.prompt("What files are in the current directory?");
+session.state.messages.forEach((msg) => {
+	console.log(msg);
+});
+console.log();

package/examples/sdk/02-custom-model.ts

@@ -0,0 +1,36 @@
+/**
+ * Custom Model Selection
+ *
+ * Shows how to select a specific model and thinking level.
+ */
+
+import { createAgentSession, findModel, discoverAvailableModels } from "../../src/index.js";
+
+// Option 1: Find a specific model by provider/id
+const { model: sonnet } = findModel("anthropic", "claude-sonnet-4-20250514");
+if (sonnet) {
+	console.log(`Found model: ${sonnet.provider}/${sonnet.id}`);
+}
+
+// Option 2: Pick from available models (have valid API keys)
+const available = await discoverAvailableModels();
+console.log(
+	"Available models:",
+	available.map((m) => `${m.provider}/${m.id}`),
+);
+
+if (available.length > 0) {
+	const { session } = await createAgentSession({
+		model: available[0],
+		thinkingLevel: "medium", // off, low, medium, high
+	});
+
+	session.subscribe((event) => {
+		if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+			process.stdout.write(event.assistantMessageEvent.delta);
+		}
+	});
+
+	await session.prompt("Say hello in one sentence.");
+	console.log();
+}

package/examples/sdk/03-custom-prompt.ts

@@ -0,0 +1,44 @@
+/**
+ * Custom System Prompt
+ *
+ * Shows how to replace or modify the default system prompt.
+ */
+
+import { createAgentSession, SessionManager } from "../../src/index.js";
+
+// Option 1: Replace prompt entirely
+const { session: session1 } = await createAgentSession({
+	systemPrompt: `You are a helpful assistant that speaks like a pirate.
+Always end responses with "Arrr!"`,
+	sessionManager: SessionManager.inMemory(),
+});
+
+session1.subscribe((event) => {
+	if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+		process.stdout.write(event.assistantMessageEvent.delta);
+	}
+});
+
+console.log("=== Replace prompt ===");
+await session1.prompt("What is 2 + 2?");
+console.log("\n");
+
+// Option 2: Modify default prompt (receives default, returns modified)
+const { session: session2 } = await createAgentSession({
+	systemPrompt: (defaultPrompt) => `${defaultPrompt}
+
+## Additional Instructions
+- Always be concise
+- Use bullet points when listing things`,
+	sessionManager: SessionManager.inMemory(),
+});
+
+session2.subscribe((event) => {
+	if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+		process.stdout.write(event.assistantMessageEvent.delta);
+	}
+});
+
+console.log("=== Modify prompt ===");
+await session2.prompt("List 3 benefits of TypeScript.");
+console.log();

package/examples/sdk/04-skills.ts

@@ -0,0 +1,44 @@
+/**
+ * Skills Configuration
+ *
+ * Skills provide specialized instructions loaded into the system prompt.
+ * Discover, filter, merge, or replace them.
+ */
+
+import { createAgentSession, discoverSkills, SessionManager, type Skill } from "../../src/index.js";
+
+// Discover all skills from cwd/.pi/skills, ~/.pi/agent/skills, etc.
+const allSkills = discoverSkills();
+console.log(
+	"Discovered skills:",
+	allSkills.map((s) => s.name),
+);
+
+// Filter to specific skills
+const filteredSkills = allSkills.filter((s) => s.name.includes("browser") || s.name.includes("search"));
+
+// Or define custom skills inline
+const customSkill: Skill = {
+	name: "my-skill",
+	description: "Custom project instructions",
+	filePath: "/virtual/SKILL.md",
+	baseDir: "/virtual",
+	source: "custom",
+};
+
+// Use filtered + custom skills
+const { session } = await createAgentSession({
+	skills: [...filteredSkills, customSkill],
+	sessionManager: SessionManager.inMemory(),
+});
+
+console.log(`Session created with ${filteredSkills.length + 1} skills`);
+
+// To disable all skills:
+// skills: []
+
+// To use discovery with filtering via settings:
+// discoverSkills(process.cwd(), undefined, {
+//   ignoredSkills: ["browser-tools"],  // glob patterns to exclude
+//   includeSkills: ["brave-*"],        // glob patterns to include (empty = all)
+// })

package/examples/sdk/05-tools.ts

@@ -0,0 +1,93 @@
+/**
+ * Tools Configuration
+ *
+ * Use built-in tool sets, individual tools, or add custom tools.
+ *
+ * IMPORTANT: When using a custom `cwd`, you must use the tool factory functions
+ * (createCodingTools, createReadOnlyTools, createReadTool, etc.) to ensure
+ * tools resolve paths relative to your cwd, not process.cwd().
+ */
+
+import { Type } from "@sinclair/typebox";
+import {
+	createAgentSession,
+	discoverCustomTools,
+	SessionManager,
+	codingTools, // read, bash, edit, write - uses process.cwd()
+	readOnlyTools, // read, grep, find, ls - uses process.cwd()
+	createCodingTools, // Factory: creates tools for specific cwd
+	createReadOnlyTools, // Factory: creates tools for specific cwd
+	createReadTool,
+	createBashTool,
+	createGrepTool,
+	readTool,
+	bashTool,
+	grepTool,
+	type CustomAgentTool,
+} from "../../src/index.js";
+
+// Read-only mode (no edit/write) - uses process.cwd()
+const { session: readOnly } = await createAgentSession({
+	tools: readOnlyTools,
+	sessionManager: SessionManager.inMemory(),
+});
+console.log("Read-only session created");
+
+// Custom tool selection - uses process.cwd()
+const { session: custom } = await createAgentSession({
+	tools: [readTool, bashTool, grepTool],
+	sessionManager: SessionManager.inMemory(),
+});
+console.log("Custom tools session created");
+
+// With custom cwd - MUST use factory functions!
+const customCwd = "/path/to/project";
+const { session: customCwdSession } = await createAgentSession({
+	cwd: customCwd,
+	tools: createCodingTools(customCwd), // Tools resolve paths relative to customCwd
+	sessionManager: SessionManager.inMemory(),
+});
+console.log("Custom cwd session created");
+
+// Or pick specific tools for custom cwd
+const { session: specificTools } = await createAgentSession({
+	cwd: customCwd,
+	tools: [createReadTool(customCwd), createBashTool(customCwd), createGrepTool(customCwd)],
+	sessionManager: SessionManager.inMemory(),
+});
+console.log("Specific tools with custom cwd session created");
+
+// Inline custom tool (needs TypeBox schema)
+const weatherTool: CustomAgentTool = {
+	name: "get_weather",
+	label: "Get Weather",
+	description: "Get current weather for a city",
+	parameters: Type.Object({
+		city: Type.String({ description: "City name" }),
+	}),
+	execute: async (_toolCallId, params) => ({
+		content: [{ type: "text", text: `Weather in ${(params as { city: string }).city}: 22°C, sunny` }],
+		details: {},
+	}),
+};
+
+const { session } = await createAgentSession({
+	customTools: [{ tool: weatherTool }],
+	sessionManager: SessionManager.inMemory(),
+});
+
+session.subscribe((event) => {
+	if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+		process.stdout.write(event.assistantMessageEvent.delta);
+	}
+});
+
+await session.prompt("What's the weather in Tokyo?");
+console.log();
+
+// Merge with discovered tools from cwd/.pi/tools and ~/.pi/agent/tools:
+// const discovered = await discoverCustomTools();
+// customTools: [...discovered, { tool: myTool }]
+
+// Or add paths without replacing discovery:
+// additionalCustomToolPaths: ["/extra/tools"]

package/examples/sdk/06-hooks.ts

@@ -0,0 +1,61 @@
+/**
+ * Hooks Configuration
+ *
+ * Hooks intercept agent events for logging, blocking, or modification.
+ */
+
+import { createAgentSession, discoverHooks, SessionManager, type HookFactory } from "../../src/index.js";
+
+// Logging hook
+const loggingHook: HookFactory = (api) => {
+	api.on("agent_start", async () => {
+		console.log("[Hook] Agent starting");
+	});
+
+	api.on("tool_call", async (event) => {
+		console.log(`[Hook] Tool: ${event.toolName}`);
+		return undefined; // Don't block
+	});
+
+	api.on("agent_end", async (event) => {
+		console.log(`[Hook] Done, ${event.messages.length} messages`);
+	});
+};
+
+// Blocking hook (returns { block: true, reason: "..." })
+const safetyHook: HookFactory = (api) => {
+	api.on("tool_call", async (event) => {
+		if (event.toolName === "bash") {
+			const cmd = (event.input as { command?: string }).command ?? "";
+			if (cmd.includes("rm -rf")) {
+				return { block: true, reason: "Dangerous command blocked" };
+			}
+		}
+		return undefined;
+	});
+};
+
+// Use inline hooks
+const { session } = await createAgentSession({
+	hooks: [{ factory: loggingHook }, { factory: safetyHook }],
+	sessionManager: SessionManager.inMemory(),
+});
+
+session.subscribe((event) => {
+	if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+		process.stdout.write(event.assistantMessageEvent.delta);
+	}
+});
+
+await session.prompt("List files in the current directory.");
+console.log();
+
+// Disable all hooks:
+// hooks: []
+
+// Merge with discovered hooks:
+// const discovered = await discoverHooks();
+// hooks: [...discovered, { factory: myHook }]
+
+// Add paths without replacing discovery:
+// additionalHookPaths: ["/extra/hooks"]

package/examples/sdk/07-context-files.ts

@@ -0,0 +1,36 @@
+/**
+ * Context Files (AGENTS.md)
+ *
+ * Context files provide project-specific instructions loaded into the system prompt.
+ */
+
+import { createAgentSession, discoverContextFiles, SessionManager } from "../../src/index.js";
+
+// Discover AGENTS.md files walking up from cwd
+const discovered = discoverContextFiles();
+console.log("Discovered context files:");
+for (const file of discovered) {
+	console.log(`  - ${file.path} (${file.content.length} chars)`);
+}
+
+// Use custom context files
+const { session } = await createAgentSession({
+	contextFiles: [
+		...discovered,
+		{
+			path: "/virtual/AGENTS.md",
+			content: `# Project Guidelines
+
+## Code Style
+- Use TypeScript strict mode
+- No any types
+- Prefer const over let`,
+		},
+	],
+	sessionManager: SessionManager.inMemory(),
+});
+
+console.log(`Session created with ${discovered.length + 1} context files`);
+
+// Disable context files:
+// contextFiles: []

package/examples/sdk/08-slash-commands.ts

@@ -0,0 +1,37 @@
+/**
+ * Slash Commands
+ *
+ * File-based commands that inject content when invoked with /commandname.
+ */
+
+import { createAgentSession, discoverSlashCommands, SessionManager, type FileSlashCommand } from "../../src/index.js";
+
+// Discover commands from cwd/.pi/commands/ and ~/.pi/agent/commands/
+const discovered = discoverSlashCommands();
+console.log("Discovered slash commands:");
+for (const cmd of discovered) {
+	console.log(`  /${cmd.name}: ${cmd.description}`);
+}
+
+// Define custom commands
+const deployCommand: FileSlashCommand = {
+	name: "deploy",
+	description: "Deploy the application",
+	source: "(custom)",
+	content: `# Deploy Instructions
+
+1. Build: npm run build
+2. Test: npm test  
+3. Deploy: npm run deploy`,
+};
+
+// Use discovered + custom commands
+const { session } = await createAgentSession({
+	slashCommands: [...discovered, deployCommand],
+	sessionManager: SessionManager.inMemory(),
+});
+
+console.log(`Session created with ${discovered.length + 1} slash commands`);
+
+// Disable slash commands:
+// slashCommands: []

package/examples/sdk/09-api-keys-and-oauth.ts

@@ -0,0 +1,45 @@
+/**
+ * API Keys and OAuth
+ *
+ * Configure API key resolution. Default checks: models.json, OAuth, env vars.
+ */
+
+import {
+	createAgentSession,
+	configureOAuthStorage,
+	defaultGetApiKey,
+	SessionManager,
+} from "../../src/index.js";
+import { getAgentDir } from "../../src/config.js";
+
+// Default: uses env vars (ANTHROPIC_API_KEY, etc.), OAuth, and models.json
+const { session: defaultSession } = await createAgentSession({
+	sessionManager: SessionManager.inMemory(),
+});
+console.log("Session with default API key resolution");
+
+// Custom resolver
+const { session: customSession } = await createAgentSession({
+	getApiKey: async (model) => {
+		// Custom logic (secrets manager, database, etc.)
+		if (model.provider === "anthropic") {
+			return process.env.MY_ANTHROPIC_KEY;
+		}
+		// Fall back to default
+		return defaultGetApiKey()(model);
+	},
+	sessionManager: SessionManager.inMemory(),
+});
+console.log("Session with custom API key resolver");
+
+// Use OAuth from ~/.pi/agent while customizing everything else
+configureOAuthStorage(getAgentDir()); // Must call before createAgentSession
+
+const { session: hybridSession } = await createAgentSession({
+	agentDir: "/tmp/custom-config", // Custom config location
+	// But OAuth tokens still come from ~/.pi/agent/oauth.json
+	systemPrompt: "You are helpful.",
+	skills: [],
+	sessionManager: SessionManager.inMemory(),
+});
+console.log("Session with OAuth from default location, custom config elsewhere");

package/examples/sdk/10-settings.ts

@@ -0,0 +1,38 @@
+/**
+ * Settings Configuration
+ *
+ * Override settings using SettingsManager.
+ */
+
+import { createAgentSession, loadSettings, SessionManager, SettingsManager } from "../../src/index.js";
+
+// Load current settings (merged global + project)
+const settings = loadSettings();
+console.log("Current settings:", JSON.stringify(settings, null, 2));
+
+// Override specific settings
+const settingsManager = SettingsManager.create();
+settingsManager.applyOverrides({
+	compaction: { enabled: false },
+	retry: { enabled: true, maxRetries: 5, baseDelayMs: 1000 },
+});
+
+const { session } = await createAgentSession({
+	settingsManager,
+	sessionManager: SessionManager.inMemory(),
+});
+
+console.log("Session created with custom settings");
+
+// For testing without file I/O:
+const inMemorySettings = SettingsManager.inMemory({
+	compaction: { enabled: false },
+	retry: { enabled: false },
+});
+
+const { session: testSession } = await createAgentSession({
+	settingsManager: inMemorySettings,
+	sessionManager: SessionManager.inMemory(),
+});
+
+console.log("Test session created with in-memory settings");

package/examples/sdk/11-sessions.ts

@@ -0,0 +1,46 @@
+/**
+ * Session Management
+ *
+ * Control session persistence: in-memory, new file, continue, or open specific.
+ */
+
+import { createAgentSession, SessionManager } from "../../src/index.js";
+
+// In-memory (no persistence)
+const { session: inMemory } = await createAgentSession({
+	sessionManager: SessionManager.inMemory(),
+});
+console.log("In-memory session:", inMemory.sessionFile ?? "(none)");
+
+// New persistent session
+const { session: newSession } = await createAgentSession({
+	sessionManager: SessionManager.create(process.cwd()),
+});
+console.log("New session file:", newSession.sessionFile);
+
+// Continue most recent session (or create new if none)
+const { session: continued, modelFallbackMessage } = await createAgentSession({
+	sessionManager: SessionManager.continueRecent(process.cwd()),
+});
+if (modelFallbackMessage) console.log("Note:", modelFallbackMessage);
+console.log("Continued session:", continued.sessionFile);
+
+// List and open specific session
+const sessions = SessionManager.list(process.cwd());
+console.log(`\nFound ${sessions.length} sessions:`);
+for (const info of sessions.slice(0, 3)) {
+	console.log(`  ${info.id.slice(0, 8)}... - "${info.firstMessage.slice(0, 30)}..."`);
+}
+
+if (sessions.length > 0) {
+	const { session: opened } = await createAgentSession({
+		sessionManager: SessionManager.open(sessions[0].path),
+	});
+	console.log(`\nOpened: ${opened.sessionId}`);
+}
+
+// Custom session directory
+// const { session } = await createAgentSession({
+//   agentDir: "/custom/agent",
+//   sessionManager: SessionManager.create(process.cwd(), "/custom/agent"),
+// });

package/examples/sdk/12-full-control.ts

@@ -0,0 +1,99 @@
+/**
+ * Full Control
+ *
+ * Replace everything - no discovery, explicit configuration.
+ * Still uses OAuth from ~/.pi/agent for convenience.
+ *
+ * IMPORTANT: When providing `tools` with a custom `cwd`, use the tool factory
+ * functions (createReadTool, createBashTool, etc.) to ensure tools resolve
+ * paths relative to your cwd.
+ */
+
+import { Type } from "@sinclair/typebox";
+import {
+	createAgentSession,
+	configureOAuthStorage,
+	defaultGetApiKey,
+	findModel,
+	SessionManager,
+	SettingsManager,
+	createReadTool,
+	createBashTool,
+	type HookFactory,
+	type CustomAgentTool,
+} from "../../src/index.js";
+import { getAgentDir } from "../../src/config.js";
+
+// Use OAuth from default location
+configureOAuthStorage(getAgentDir());
+
+// Custom API key with fallback
+const getApiKey = async (model: { provider: string }) => {
+	if (model.provider === "anthropic" && process.env.MY_ANTHROPIC_KEY) {
+		return process.env.MY_ANTHROPIC_KEY;
+	}
+	return defaultGetApiKey()(model as any);
+};
+
+// Inline hook
+const auditHook: HookFactory = (api) => {
+	api.on("tool_call", async (event) => {
+		console.log(`[Audit] ${event.toolName}`);
+		return undefined;
+	});
+};
+
+// Inline custom tool
+const statusTool: CustomAgentTool = {
+	name: "status",
+	label: "Status",
+	description: "Get system status",
+	parameters: Type.Object({}),
+	execute: async () => ({
+		content: [{ type: "text", text: `Uptime: ${process.uptime()}s, Node: ${process.version}` }],
+		details: {},
+	}),
+};
+
+const { model } = findModel("anthropic", "claude-sonnet-4-20250514");
+if (!model) throw new Error("Model not found");
+
+// In-memory settings with overrides
+const settingsManager = SettingsManager.inMemory({
+	compaction: { enabled: false },
+	retry: { enabled: true, maxRetries: 2 },
+});
+
+// When using a custom cwd with explicit tools, use the factory functions
+const cwd = process.cwd();
+
+const { session } = await createAgentSession({
+	cwd,
+	agentDir: "/tmp/my-agent",
+
+	model,
+	thinkingLevel: "off",
+	getApiKey,
+
+	systemPrompt: `You are a minimal assistant.
+Available: read, bash, status. Be concise.`,
+
+	// Use factory functions with the same cwd to ensure path resolution works correctly
+	tools: [createReadTool(cwd), createBashTool(cwd)],
+	customTools: [{ tool: statusTool }],
+	hooks: [{ factory: auditHook }],
+	skills: [],
+	contextFiles: [],
+	slashCommands: [],
+	sessionManager: SessionManager.inMemory(),
+	settingsManager,
+});
+
+session.subscribe((event) => {
+	if (event.type === "message_update" && event.assistantMessageEvent.type === "text_delta") {
+		process.stdout.write(event.assistantMessageEvent.delta);
+	}
+});
+
+await session.prompt("Get status and list files.");
+console.log();