Interface: ChatSettings
Defined in: chat/chatController.ts:29
What the controller needs besides the session: the chats' options it acts on.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
agentLabel? | string | The label before the agent's reply in the session log. | chat/chatController.ts:39 |
commands? | Record<string, () => void | Promise<void>> | The view's own commands, by name without the slash (a terminal's /copy): logged and kept in the history like any line, then run by the view. | chat/chatController.ts:61 |
exitCommands? | readonly string[] | Lines (trimmed, case-insensitive) that end the chat. Default /exit, /quit. | chat/chatController.ts:31 |
formatAction? | (toolName, input) => string | Tool call labels and folded-group phrases on top of the kit's and the extensions'. | chat/chatController.ts:49 |
historyLimit? | number | - | chat/chatController.ts:42 |
historyPath? | string | The person's lines, kept across runs (↑/↓). | chat/chatController.ts:41 |
initialPrompt? | string | The first turn, sent before the person types anything, unless the run resumes a conversation. | chat/chatController.ts:33 |
modeControl? | ModeControl | Without one, the session's mode control and tool labels. | chat/chatController.ts:46 |
panels? | "view" | "state" | Who asks the person at a checkpoint: "view" (the default) leaves the interaction port to the view (a terminal's panels); "state" installs the controller's own, whose panel is the state's panel, answered with answer(). | chat/chatController.ts:67 |
pick? | (title, options) => Promise<string | null> | How a choice in place of the prompt is asked (the conversations of /resume): a terminal view asks it its way; without it, it's the state's choice, answered with choose(). | chat/chatController.ts:59 |
promptLabel? | string | The label before the person's lines in the session log. | chat/chatController.ts:37 |
promptSuggestions? | boolean | The SDK's prompt suggestions (on by default). | chat/chatController.ts:54 |
runQuery? | (prompt, options) => AgentRun | Runs the agent: the SDK's (runQuery()) by default; another for tests, or a host of its own. | chat/chatController.ts:52 |
runsDir? | string | With a session opener: where the runs are (required then). | chat/chatController.ts:44 |
sessionLogPath? | string | The session log without runs (with runs, each run's session.log). | chat/chatController.ts:35 |
toolLabels? | Readonly<Record<string, ToolLabel>> | - | chat/chatController.ts:47 |
toolPhrase? | (toolName) => ToolPhrase | undefined | - | chat/chatController.ts:50 |