/** * SDK for programmatic usage of AgentSession. * * Provides a factory function and discovery helpers that allow full control * over agent configuration, or sensible defaults that match CLI behavior. * * @example * ```typescript * // Minimal - everything auto-discovered * const session = await createAgentSession(); * * // With custom hooks * const session = await createAgentSession({ * hooks: [ * ...await discoverHooks(), * { factory: myHookFactory }, * ], * }); * * // Full control * const session = await createAgentSession({ * model: myModel, * getApiKey: async () => process.env.MY_KEY, * tools: [readTool, bashTool], * hooks: [], * skills: [], * sessionFile: false, * }); * ``` */ import { Agent, ProviderTransport, type ThinkingLevel } from "@mariozechner/pi-agent-core"; import type { Model } from "@mariozechner/pi-ai"; import { getAgentDir } from "../config.js"; import { AgentSession } from "./agent-session.js"; import { discoverAndLoadCustomTools, type LoadedCustomTool } from "./custom-tools/index.js"; import type { CustomAgentTool } from "./custom-tools/types.js"; import { discoverAndLoadHooks, HookRunner, type LoadedHook, wrapToolsWithHooks } from "./hooks/index.js"; import type { HookFactory } from "./hooks/types.js"; import { messageTransformer } from "./messages.js"; import { findModel as findModelInternal, getApiKeyForModel, getAvailableModels, loadAndMergeModels, } from "./model-config.js"; import { SessionManager } from "./session-manager.js"; import { type Settings, SettingsManager, type SkillsSettings } from "./settings-manager.js"; import { loadSkills as loadSkillsInternal, type Skill } from "./skills.js"; import { type FileSlashCommand, loadSlashCommands as loadSlashCommandsInternal } from "./slash-commands.js"; import { buildSystemPrompt as buildSystemPromptInternal, loadProjectContextFiles as loadContextFilesInternal, } from "./system-prompt.js"; import { allTools, bashTool, codingTools, editTool, findTool, grepTool, lsTool, readOnlyTools, readTool, type Tool, writeTool, } from "./tools/index.js"; // ============================================================================ // Types // ============================================================================ export interface CreateAgentSessionOptions { // === Environment === /** Working directory for project-local discovery. Default: process.cwd() */ cwd?: string; /** Global config directory. Default: ~/.pi/agent */ agentDir?: string; // === Model & Thinking === /** Model to use. Default: from settings, else first available */ model?: Model; /** Thinking level. Default: from settings, else 'off' (clamped to model capabilities) */ thinkingLevel?: ThinkingLevel; // === API Key === /** API key resolver. Default: defaultGetApiKey() */ getApiKey?: (model: Model) => Promise; // === System Prompt === /** System prompt. String replaces default, function receives default and returns final. */ systemPrompt?: string | ((defaultPrompt: string) => string); // === Tools === /** Built-in tools to use. Default: codingTools [read, bash, edit, write] */ tools?: Tool[]; /** Custom tools. Default: discovered from cwd/.pi/tools/ + agentDir/tools/ */ customTools?: Array<{ path?: string; tool: CustomAgentTool }>; // === Hooks === /** Hooks. Default: discovered from cwd/.pi/hooks/ + agentDir/hooks/ */ hooks?: Array<{ path?: string; factory: HookFactory }>; // === Context === /** Skills. Default: discovered from multiple locations */ skills?: Skill[]; /** Context files (AGENTS.md content). Default: discovered walking up from cwd */ contextFiles?: Array<{ path: string; content: string }>; /** Slash commands. Default: discovered from cwd/.pi/commands/ + agentDir/commands/ */ slashCommands?: FileSlashCommand[]; // === Session === /** Session file path, or false to disable persistence. Default: auto in agentDir/sessions/ */ sessionFile?: string | false; // === Settings === /** Settings overrides (merged with agentDir/settings.json) */ settings?: Partial; } // ============================================================================ // Re-exports // ============================================================================ export type { CustomAgentTool } from "./custom-tools/types.js"; export type { HookAPI, HookFactory } from "./hooks/types.js"; export type { Settings, SkillsSettings } from "./settings-manager.js"; export type { Skill } from "./skills.js"; export type { FileSlashCommand } from "./slash-commands.js"; export type { Tool } from "./tools/index.js"; export { readTool, bashTool, editTool, writeTool, grepTool, findTool, lsTool, codingTools, readOnlyTools, allTools as allBuiltInTools, }; // ============================================================================ // Helper Functions // ============================================================================ function getDefaultAgentDir(): string { return getAgentDir(); } // ============================================================================ // Discovery Functions // ============================================================================ /** * Get all models (built-in + custom from models.json). * Note: Uses default agentDir for models.json location. */ export function discoverModels(): Model[] { const { models, error } = loadAndMergeModels(); if (error) { throw new Error(error); } return models; } /** * Get models that have valid API keys available. * Note: Uses default agentDir for models.json and oauth.json location. */ export async function discoverAvailableModels(): Promise[]> { const { models, error } = await getAvailableModels(); if (error) { throw new Error(error); } return models; } /** * Find a model by provider and ID. * Note: Uses default agentDir for models.json location. * @returns The model, or null if not found */ export function findModel(provider: string, modelId: string): Model | null { const { model, error } = findModelInternal(provider, modelId); if (error) { throw new Error(error); } return model; } /** * Discover hooks from cwd and agentDir. */ export async function discoverHooks( cwd?: string, agentDir?: string, ): Promise> { const resolvedCwd = cwd ?? process.cwd(); const resolvedAgentDir = agentDir ?? getDefaultAgentDir(); const { hooks, errors } = await discoverAndLoadHooks([], resolvedCwd, resolvedAgentDir); // Log errors but don't fail for (const { path, error } of errors) { console.error(`Failed to load hook "${path}": ${error}`); } return hooks.map((h) => ({ path: h.path, factory: createFactoryFromLoadedHook(h), })); } /** * Discover custom tools from cwd and agentDir. */ export async function discoverCustomTools( cwd?: string, agentDir?: string, ): Promise> { const resolvedCwd = cwd ?? process.cwd(); const resolvedAgentDir = agentDir ?? getDefaultAgentDir(); const { tools, errors } = await discoverAndLoadCustomTools([], resolvedCwd, Object.keys(allTools), resolvedAgentDir); // Log errors but don't fail for (const { path, error } of errors) { console.error(`Failed to load custom tool "${path}": ${error}`); } return tools.map((t) => ({ path: t.path, tool: t.tool, })); } /** * Discover skills from cwd and agentDir. */ export function discoverSkills(cwd?: string, agentDir?: string, settings?: SkillsSettings): Skill[] { const { skills } = loadSkillsInternal({ ...settings, cwd: cwd ?? process.cwd(), agentDir: agentDir ?? getDefaultAgentDir(), }); return skills; } /** * Discover context files (AGENTS.md) walking up from cwd. */ export function discoverContextFiles(cwd?: string, agentDir?: string): Array<{ path: string; content: string }> { return loadContextFilesInternal({ cwd: cwd ?? process.cwd(), agentDir: agentDir ?? getDefaultAgentDir(), }); } /** * Discover slash commands from cwd and agentDir. */ export function discoverSlashCommands(cwd?: string, agentDir?: string): FileSlashCommand[] { return loadSlashCommandsInternal({ cwd: cwd ?? process.cwd(), agentDir: agentDir ?? getDefaultAgentDir(), }); } // ============================================================================ // API Key Helpers // ============================================================================ /** * Create the default API key resolver. * Checks custom providers (models.json), OAuth, and environment variables. * Note: Uses default agentDir for models.json and oauth.json location. */ export function defaultGetApiKey(): (model: Model) => Promise { return getApiKeyForModel; } // ============================================================================ // System Prompt // ============================================================================ export interface BuildSystemPromptOptions { tools?: Tool[]; skills?: Skill[]; contextFiles?: Array<{ path: string; content: string }>; cwd?: string; appendPrompt?: string; } /** * Build the default system prompt. */ export function buildSystemPrompt(options: BuildSystemPromptOptions = {}): string { return buildSystemPromptInternal({ cwd: options.cwd, skills: options.skills, contextFiles: options.contextFiles, appendSystemPrompt: options.appendPrompt, }); } // ============================================================================ // Settings // ============================================================================ /** * Load settings from agentDir/settings.json. */ export function loadSettings(agentDir?: string): Settings { const manager = new SettingsManager(agentDir ?? getDefaultAgentDir()); return { defaultProvider: manager.getDefaultProvider(), defaultModel: manager.getDefaultModel(), defaultThinkingLevel: manager.getDefaultThinkingLevel(), queueMode: manager.getQueueMode(), theme: manager.getTheme(), compaction: manager.getCompactionSettings(), retry: manager.getRetrySettings(), hideThinkingBlock: manager.getHideThinkingBlock(), shellPath: manager.getShellPath(), collapseChangelog: manager.getCollapseChangelog(), hooks: manager.getHookPaths(), hookTimeout: manager.getHookTimeout(), customTools: manager.getCustomToolPaths(), skills: manager.getSkillsSettings(), terminal: { showImages: manager.getShowImages() }, }; } // ============================================================================ // Internal Helpers // ============================================================================ /** * Create a HookFactory from a LoadedHook. * This allows mixing discovered hooks with inline hooks. */ function createFactoryFromLoadedHook(loaded: LoadedHook): HookFactory { return (api) => { for (const [eventType, handlers] of loaded.handlers) { for (const handler of handlers) { api.on(eventType as any, handler as any); } } }; } /** * Convert hook definitions to LoadedHooks for the HookRunner. */ function createLoadedHooksFromDefinitions(definitions: Array<{ path?: string; factory: HookFactory }>): LoadedHook[] { return definitions.map((def) => { const handlers = new Map Promise>>(); let sendHandler: (text: string, attachments?: any[]) => void = () => {}; const api = { on: (event: string, handler: (...args: unknown[]) => Promise) => { const list = handlers.get(event) ?? []; list.push(handler); handlers.set(event, list); }, send: (text: string, attachments?: any[]) => { sendHandler(text, attachments); }, }; def.factory(api as any); return { path: def.path ?? "", resolvedPath: def.path ?? "", handlers, setSendHandler: (handler: (text: string, attachments?: any[]) => void) => { sendHandler = handler; }, }; }); } // ============================================================================ // Factory // ============================================================================ /** * Create an AgentSession with the specified options. * * @example * ```typescript * // Minimal - uses defaults * const session = await createAgentSession(); * * // With explicit model * const session = await createAgentSession({ * model: findModel('anthropic', 'claude-sonnet-4-20250514'), * thinkingLevel: 'high', * }); * * // Full control * const session = await createAgentSession({ * model: myModel, * getApiKey: async () => process.env.MY_KEY, * systemPrompt: 'You are helpful.', * tools: [readTool, bashTool], * hooks: [], * skills: [], * sessionFile: false, * }); * ``` */ export async function createAgentSession(options: CreateAgentSessionOptions = {}): Promise { const cwd = options.cwd ?? process.cwd(); const agentDir = options.agentDir ?? getDefaultAgentDir(); // === Settings === const settingsManager = new SettingsManager(agentDir); // === Model Resolution === let model = options.model; if (!model) { // Try settings default const defaultProvider = settingsManager.getDefaultProvider(); const defaultModelId = settingsManager.getDefaultModel(); if (defaultProvider && defaultModelId) { model = findModel(defaultProvider, defaultModelId) ?? undefined; // Verify it has an API key if (model) { const key = await getApiKeyForModel(model); if (!key) { model = undefined; } } } // Fall back to first available if (!model) { const available = await discoverAvailableModels(); if (available.length === 0) { throw new Error( "No models available. Set an API key environment variable " + "(ANTHROPIC_API_KEY, OPENAI_API_KEY, etc.) or provide a model explicitly.", ); } model = available[0]; } } // === Thinking Level Resolution === let thinkingLevel = options.thinkingLevel; if (thinkingLevel === undefined) { thinkingLevel = settingsManager.getDefaultThinkingLevel() ?? "off"; } // Clamp to model capabilities if (!model.reasoning) { thinkingLevel = "off"; } // === API Key Resolver === const getApiKey = options.getApiKey ?? defaultGetApiKey(); // === Skills === const skills = options.skills ?? discoverSkills(cwd, agentDir, settingsManager.getSkillsSettings()); // === Context Files === const contextFiles = options.contextFiles ?? discoverContextFiles(cwd, agentDir); // === Tools === const builtInTools = options.tools ?? codingTools; // === Custom Tools === let customToolsResult: { tools: LoadedCustomTool[]; setUIContext: (ctx: any, hasUI: boolean) => void }; if (options.customTools !== undefined) { // Use provided custom tools const loadedTools: LoadedCustomTool[] = options.customTools.map((ct) => ({ path: ct.path ?? "", resolvedPath: ct.path ?? "", tool: ct.tool, })); customToolsResult = { tools: loadedTools, setUIContext: () => {}, }; } else { // Discover custom tools const result = await discoverAndLoadCustomTools( settingsManager.getCustomToolPaths(), cwd, Object.keys(allTools), agentDir, ); for (const { path, error } of result.errors) { console.error(`Failed to load custom tool "${path}": ${error}`); } customToolsResult = result; } // === Hooks === let hookRunner: HookRunner | null = null; if (options.hooks !== undefined) { if (options.hooks.length > 0) { const loadedHooks = createLoadedHooksFromDefinitions(options.hooks); hookRunner = new HookRunner(loadedHooks, cwd, settingsManager.getHookTimeout()); } } else { // Discover hooks const { hooks, errors } = await discoverAndLoadHooks(settingsManager.getHookPaths(), cwd, agentDir); for (const { path, error } of errors) { console.error(`Failed to load hook "${path}": ${error}`); } if (hooks.length > 0) { hookRunner = new HookRunner(hooks, cwd, settingsManager.getHookTimeout()); } } // === Combine and wrap tools === let allToolsArray: Tool[] = [...builtInTools, ...customToolsResult.tools.map((lt) => lt.tool as unknown as Tool)]; if (hookRunner) { allToolsArray = wrapToolsWithHooks(allToolsArray, hookRunner) as Tool[]; } // === System Prompt === let systemPrompt: string; const defaultPrompt = buildSystemPromptInternal({ cwd, agentDir, skills, contextFiles, }); if (options.systemPrompt === undefined) { systemPrompt = defaultPrompt; } else if (typeof options.systemPrompt === "string") { systemPrompt = options.systemPrompt; } else { systemPrompt = options.systemPrompt(defaultPrompt); } // === Slash Commands === const slashCommands = options.slashCommands ?? discoverSlashCommands(cwd, agentDir); // === Session Manager === const sessionManager = new SessionManager(false, undefined); if (options.sessionFile === false) { sessionManager.disable(); } else if (typeof options.sessionFile === "string") { sessionManager.setSessionFile(options.sessionFile); } // If undefined, SessionManager uses auto-detection based on cwd // === Create Agent === const agent = new Agent({ initialState: { systemPrompt, model, thinkingLevel, tools: allToolsArray, }, messageTransformer, queueMode: settingsManager.getQueueMode(), transport: new ProviderTransport({ getApiKey: async () => { const currentModel = agent.state.model; if (!currentModel) { throw new Error("No model selected"); } const key = await getApiKey(currentModel); if (!key) { throw new Error(`No API key found for provider "${currentModel.provider}"`); } return key; }, }), }); // === Create Session === const session = new AgentSession({ agent, sessionManager, settingsManager, fileCommands: slashCommands, hookRunner, customTools: customToolsResult.tools, skillsSettings: settingsManager.getSkillsSettings(), }); return session; }