Skip to main content
Version: 0.13.0

Interface: ProgressViewOptions

Defined in: tui/ink/progressView.tsx:16

Options of createProgressView().

Extends​

Properties​

PropertyTypeDescriptionInherited fromDefined in
agentLabel?stringPrinted (already styled) before the first text of each turn, e.g. "my-agent>".ConsoleRendererOptions.agentLabeltui/consoleRenderer.ts:12
formatAction?(toolName, toolInput) => stringTurns a tool call into its console label; defaults to createFriendlyToolLabel().ConsoleRendererOptions.formatActiontui/consoleRenderer.ts:10
language?stringThe 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:36
mode?ModeShown in the status bar.-tui/ink/progressView.tsx:22
onWrite?(text) => voidCalled after every write with the same text, e.g. to mirror it into a log file.ConsoleRendererOptions.onWritetui/consoleRenderer.ts:16
plain?booleanUse the plain console renderer even on a TTY.-tui/ink/progressView.tsx:24
renderApproval?RenderApprovalReplaces the default preview in the approval and manual-intervention panels.-tui/ink/progressView.tsx:20
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:30
toolPhrase?(toolName) => ToolPhrase | undefinedHow one of the agent's own tools counts in a folded group's summary (see InkChatOptions.toolPhrase).-tui/ink/progressView.tsx:18