Skip to main content
Version: 0.17.0

Function: runChatInk()

function runChatInk(options, tuiOptions?): Promise<void>;

Defined in: tui/ink/runChatInk.tsx:346

The Ink counterpart of runChatTui(), with the same options, session log and history file: history in the scrollback, the reply streaming in place, a spinner with the current action (and a subagent's), approval panels, "/command" completion and a status bar. Checkpoints go through an Ink InteractionPort while the chat runs, so no second stdin reader ever competes with Ink's; the response file keeps working as always.

With fullscreen it takes the whole terminal instead (see InkChatOptions.fullscreen).

Given a session opener instead of options, and runsDir, each run keeps its conversation in its own folder and can be resumed: --continue on the command line starts with the latest, and /resume picks one (see ChatTuiOptions.runsDir).

Without a TTY (piped, background) or with plain, it is runChatTui() unchanged.

Parameters​

ParameterType
optionsOptions | SessionOpener
tuiOptionsInkChatOptions

Returns​

Promise<void>