@compilr-dev/cli 0.5.16 → 0.6.0

package/dist/agent.d.ts

@@ -1,12 +1,13 @@
 /**
  * Agent Configuration
  *
- * Creates and configures the Agent instance with
- * ClaudeProvider, OllamaProvider, OpenAIProvider, or GeminiProvider
- * and available tools.
+ * Thin wrapper around createCompilrAgent() from @compilr-dev/sdk.
+ * Handles CLI-specific concerns: credential resolution, system prompt
+ * assembly, subagent callbacks, and token estimates.
  */
 import { Agent } from '@compilr-dev/sdk';
-import type { AgentEvent, PermissionHandler, Tool, GuardrailTriggeredHandler } from '@compilr-dev/sdk';
+import type { AgentEvent, Tool, GuardrailTriggeredHandler } from '@compilr-dev/sdk';
+import type { PermissionHandler } from '@compilr-dev/agents';
 import type { EpisodeRecorder } from './episodes/index.js';
 /**
  * Supported providers (re-exported from models/provider-types)
@@ -44,44 +45,21 @@ export interface AgentOptions {
      * or false to stop execution.
      */
     onIterationLimitReached?: (context: IterationLimitContext) => Promise<number | false>;
-    /**
-     * Active project display name (e.g. "Hr Manager").
-     */
+    /** Active project display name */
     projectName?: string;
-    /**
-     * Active project slug — unique identifier (e.g. "hr-manager").
-     */
+    /** Active project slug */
     projectSlug?: string;
-    /**
-     * Active project ID (numeric database identifier).
-     */
+    /** Active project ID */
     projectId?: number;
-    /**
-     * Project context from COMPILR.md or CLAUDE.md.
-     * This is appended to the system prompt to give the agent project-specific knowledge.
-     */
+    /** Project context from COMPILR.md or CLAUDE.md */
     projectContext?: string;
-    /**
-     * Guided workflow context.
-     * Appended to the system prompt when in guided mode.
-     * Generated by the workflow module based on project/item state.
-     */
+    /** Guided workflow context */
     guidedModeContext?: string;
-    /**
-     * Plan mode context.
-     * Appended to the system prompt when in plan mode.
-     * Instructs the agent to explore, plan, and wait for approval before implementing.
-     */
+    /** Plan mode context */
     planModeContext?: string;
-    /**
-     * Enable anchors (critical info that survives compaction).
-     * When true, agent is configured with AnchorManager.
-     */
+    /** Enable anchors (critical info that survives compaction) */
     enableAnchors?: boolean;
-    /**
-     * Pre-loaded anchors to add to the agent at startup.
-     * These are loaded from persisted files (global + project).
-     */
+    /** Pre-loaded anchors to add at startup */
     persistedAnchors?: Array<{
         id?: string;
         content: string;
@@ -90,94 +68,37 @@ export interface AgentOptions {
         tags?: string[];
         projectId?: string;
     }>;
-    /**
-     * Enable guardrails (safety checks for risky operations).
-     * When true, 15 built-in patterns are enabled for git, filesystem, database, etc.
-     * Warnings are emitted as 'guardrail_warning' events on the agent.
-     */
+    /** Enable guardrails (safety checks for risky operations) */
     enableGuardrails?: boolean;
-    /**
-     * Callback for guardrail confirmation prompts.
-     * Called when a guardrail with action='confirm' is triggered.
-     * Return true to proceed, false to block.
-     */
+    /** Callback for guardrail confirmation prompts */
     onGuardrailTriggered?: GuardrailTriggeredHandler;
-    /**
-     * Callback when a subagent starts (task tool spawns agent).
-     * @param toolUseId - Tool use ID for correlation (from task tool's tool_start event)
-     * @param agentType - Type of agent being spawned
-     * @param description - Task description
-     */
+    /** Callback when a subagent starts */
     onSubagentStart?: (toolUseId: string, agentType: string, description: string) => void;
-    /**
-     * Callback when a subagent completes.
-     * @param toolUseId - Tool use ID for correlation
-     * @param success - Whether the subagent completed successfully
-     * @param tokenCount - Total tokens used by the subagent
-     * @param error - Error message if failed
-     */
+    /** Callback when a subagent completes */
     onSubagentEnd?: (toolUseId: string, success: boolean, tokenCount: number, error?: string) => void;
-    /**
-     * Callback when a subagent uses a tool (for live updates).
-     * @param toolUseId - Tool use ID for correlation
-     * @param toolName - Name of the tool being used
-     * @param summary - Optional summary of what the tool is doing
-     */
+    /** Callback when a subagent uses a tool (for live updates) */
     onSubagentToolUse?: (toolUseId: string, toolName: string, summary?: string) => void;
-    /**
-     * Callback invoked when subagent tracking should be cleared (e.g., new run starting).
-     * Returns a function to clear the tracking state.
-     */
+    /** Callback for subagent tracking state clear */
     onSubagentTrackingReady?: (clearTracking: () => void) => void;
-    /**
-     * Enable meta-tools for token optimization (EXPERIMENTAL).
-     * When true, only direct tools are declared normally.
-     * Specialized tools are available via use_tool() meta-function.
-     * Reduces token overhead from ~15K to ~5K per request.
-     */
+    /** Enable meta-tools / capability loading for token optimization */
     enableMetaTools?: boolean;
-    /**
-     * Additional system prompt content for role-specific agents.
-     * This is appended to the end of the built system prompt.
-     * Used for team agents with specialized personas.
-     */
+    /** Additional system prompt for role-specific agents */
     systemPromptAddition?: string;
-    /**
-     * Suppress startup console logs (provider info, meta-tools stats, system prompt stats).
-     * Used for team agents created during runtime to avoid interfering with UI.
-     */
+    /** Suppress startup logs (for team agents) */
     quiet?: boolean;
-    /**
-     * Use minimal system prompt - skip all modules and just use systemPromptAddition.
-     * Used for testing role identity without module interference.
-     */
+    /** Use minimal system prompt (just systemPromptAddition) */
     useMinimalSystemPrompt?: boolean;
-    /**
-     * Skip all tool registration - agent has no tools.
-     * Used for testing role identity without tool interference.
-     */
+    /** Skip all tool registration */
     noTools?: boolean;
-    /**
-     * Tool filter - limit which tools this agent can use.
-     * When set, only tools in this list will be registered.
-     * Applies to both direct tools and meta-registry tools.
-     */
+    /** Tool filter — limit which tools this agent can use */
     toolFilter?: string[];
-    /**
-     * MCP tools discovered from external MCP servers.
-     * These are registered alongside built-in tools.
-     * The LLM sees them identically to native tools.
-     */
+    /** MCP tools from external MCP servers */
     mcpTools?: Tool[];
-    /**
-     * Episode recorder for tracking work history.
-     * When provided, its AfterToolHook is registered to observe tool calls.
-     */
+    /** Episode recorder for work history tracking */
     episodeRecorder?: EpisodeRecorder;
 }
 /**
  * Get permission info for a tool by name.
- * Returns undefined if the tool doesn't require special permission (always allowed).
  */
 export declare function getToolPermissionInfo(toolName: string): {
     level: 'once' | 'always' | 'session';
@@ -185,7 +106,6 @@ export declare function getToolPermissionInfo(toolName: string): {
 } | undefined;
 /**
  * Get information about built-in guardrails.
- * Used for displaying guardrail info in /help or status overlays.
  */
 export declare function getBuiltinGuardrailInfo(): Array<{
     id: string;
@@ -194,11 +114,19 @@ export declare function getBuiltinGuardrailInfo(): Array<{
     action: 'warn' | 'confirm' | 'block';
     category: string;
 }>;
-/**
- * Derive profile group IDs from a tool filter (array of tool names).
- * A group is included if any of its tools are in the filter.
- */
 /**
  * Creates an Agent instance configured with all tools.
+ *
+ * Delegates to createCompilrAgent() from @compilr-dev/sdk for:
+ * - Provider creation, context management, observation masking
+ * - Smart windowing, tool output guards
+ * - Capability loading (meta-tools, dynamic prompt assembly)
+ * - Permission handling, guardrails, delegation
+ *
+ * CLI adds on top:
+ * - Credential resolution from CLI keystore
+ * - System prompt with project context and role identity
+ * - Subagent callbacks for UI updates
+ * - Token estimate logging
  */
 export declare function createAgent(options?: AgentOptions): Agent;