@ai-sdk/tui 0.0.0-6b196531-20260710185421

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+import { Agent, Experimental_SandboxSession } from 'ai';
+
+/**
+ * Controls how terminal UI sections for stream parts are displayed.
+ *
+ * - `full`: show the section header and full content.
+ * - `collapsed`: show only the section header.
+ * - `auto-collapsed`: show the latest section expanded until another visible
+ *   section appears, then collapse it.
+ * - `hidden`: omit the section entirely.
+ */
+type TerminalPartDisplayMode = 'full' | 'collapsed' | 'auto-collapsed' | 'hidden';
+/**
+ * Controls which response statistic is shown.
+ *
+ * - `outputTokenCount`: show the number of output tokens in the response.
+ * - `outputTokensPerSecond`: show output token throughput for the response.
+ */
+type ResponseStatisticsMode = 'outputTokenCount' | 'outputTokensPerSecond';
+/**
+ * An agent that is compatible with the terminal UI.
+ */
+type AgentTUIAgent = Agent<any, any, any, any>;
+/**
+ * Options for starting an agent in the default terminal UI.
+ */
+type RunAgentTUIOptions = {
+    /**
+     * The agent to run.
+     */
+    agent: AgentTUIAgent;
+    /**
+     * The title shown in the terminal UI.
+     */
+    title?: string;
+    /**
+     * How tool calls should render.
+     *
+     * @default "auto-collapsed"
+     */
+    tools?: TerminalPartDisplayMode;
+    /**
+     * How reasoning parts should render.
+     *
+     * @default "auto-collapsed"
+     */
+    reasoning?: TerminalPartDisplayMode;
+    /**
+     * Which response statistic to show.
+     *
+     * @default "outputTokensPerSecond"
+     */
+    responseStatistics?: ResponseStatisticsMode;
+    /**
+     * The model context window size in tokens.
+     *
+     * When provided, the terminal UI shows the current total token usage as a
+     * percentage of this context window.
+     */
+    contextSize?: number;
+    /**
+     * Sandbox session that is passed through to agent tool execution.
+     */
+    sandbox?: Experimental_SandboxSession;
+};
+/**
+ * Runs an agent in the default terminal UI until the user exits.
+ */
+declare function runAgentTUI(options: RunAgentTUIOptions): Promise<void>;
+
+export { type AgentTUIAgent, type ResponseStatisticsMode, type RunAgentTUIOptions, type TerminalPartDisplayMode, runAgentTUI };