Interface: ProgressViewOptions
Defined in: tui/ink/progressView.tsx:16
Options of createProgressView().
Extends
Omit<ConsoleRendererOptions,"output">
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
agentLabel? | string | Printed (already styled) before the first text of each turn, e.g. "my-agent>". | ConsoleRendererOptions.agentLabel | tui/consoleRenderer.ts:13 |
formatAction? | (toolName, toolInput) => string | Turns a tool call into its console label; defaults to createFriendlyToolLabel(). | ConsoleRendererOptions.formatAction | tui/consoleRenderer.ts:11 |
formatResult? | ResultFormatter | The result line under a tool call (see InkChatOptions.formatResult). | - | tui/ink/progressView.tsx:22 |
language? | string | The language of the kit's texts ("en", "es", "fr", "de"). --language=<code> on the command line wins; without either, the one buildSessionOptions() chose from config.language, or else the system's. | - | tui/ink/progressView.tsx:40 |
mode? | Mode | Shown in the status bar. | - | tui/ink/progressView.tsx:26 |
onWrite? | (text) => void | Called after every write with the same text, e.g. to mirror it into a log file. | ConsoleRendererOptions.onWrite | tui/consoleRenderer.ts:17 |
plain? | boolean | Use the plain console renderer even on a TTY. | - | tui/ink/progressView.tsx:28 |
renderApproval? | RenderApproval | Replaces the default preview in the approval and manual-intervention panels. | - | tui/ink/progressView.tsx:24 |
theme? | Partial<Theme> | Colors for the kit's roles (see Theme), on top of the kit's defaults: only the roles given change, e.g. { toolResult: "yellow", selection: "#00ff00" }. One theme per process: without this option, the one already set stays. | - | tui/ink/progressView.tsx:34 |
toolDetail? | ToolDetail | How much of the tool calls shows (see InkChatOptions.toolDetail); "full" if not given. | - | tui/ink/progressView.tsx:20 |
toolPhrase? | (toolName) => ToolPhrase | undefined | How one of the agent's own tools counts in a folded group's summary (see InkChatOptions.toolPhrase). | - | tui/ink/progressView.tsx:18 |