messages

Documentation

Overview

Package messages defines all TUI message types organized by domain.

Messages are grouped into domain-specific files:

• session.go: Session lifecycle (new, exit, save, load, etc.)
• theme.go: Theme selection and preview
• agent.go: Agent switching and model selection
• toggle.go: UI state toggles (YOLO, thinking, sidebar)
• input.go: Editor input, attachments, and speech
• mcp.go: MCP prompt interactions

This organization follows the Elm Architecture principle of grouping messages by the domain they affect, making it easier to understand which components handle which messages.

Package messages defines all TUI message types organized by domain.

Index

• type AgentCommandMsg
• type AttachFileMsg
• type ChangeModelMsg
• type ChangeThemeMsg
• type ClearQueueMsg
• type CompactSessionMsg
• type CopyLastResponseToClipboardMsg
• type CopySessionToClipboardMsg
• type ElicitationResponseMsg
• type EvalSessionMsg
• type ExitAfterFirstResponseMsg
• type ExitSessionMsg
• type ExportSessionMsg
• type InsertFileRefMsg
• type LoadSessionMsg
• type MCPPromptMsg
• type NewSessionMsg
• type OpenModelPickerMsg
• type OpenSessionBrowserMsg
• type OpenThemePickerMsg
• type OpenURLMsg
• type RegenerateTitleMsg
• type SendAttachmentMsg
• type SendMsg
• type SetSessionTitleMsg
• type ShowCostDialogMsg
• type ShowMCPPromptInputMsg
• type ShowPermissionsDialogMsg
• type SpeakTranscriptMsg
• type StartShellMsg
• type StartSpeakMsg
• type StopSpeakMsg
• type StreamCancelledMsg
• type SwitchAgentMsg
• type ThemeCancelPreviewMsg
• type ThemeChangedMsg
• type ThemeFileChangedMsg
• type ThemePreviewMsg
• type ToggleHideToolResultsMsg
• type ToggleSessionStarMsg
• type ToggleSidebarMsg
• type ToggleThinkingMsg
• type ToggleYoloMsg

Types

type AgentCommandMsg

type AgentCommandMsg struct{ Command string }

AgentCommandMsg sends a command to the agent.

type AttachFileMsg

type AttachFileMsg struct{ FilePath string }

AttachFileMsg attaches a file directly or opens file picker if empty/directory.

type ChangeModelMsg

type ChangeModelMsg struct{ ModelRef string }

ChangeModelMsg changes the model for the current agent.

type ChangeThemeMsg

type ChangeThemeMsg struct {
	ThemeRef string // Theme reference to apply
}

ChangeThemeMsg applies the specified theme.

type ClearQueueMsg

type ClearQueueMsg struct{}

ClearQueueMsg clears all queued messages.

type CompactSessionMsg

type CompactSessionMsg struct{ AdditionalPrompt string }

CompactSessionMsg generates a summary and compacts session history.

type CopyLastResponseToClipboardMsg

type CopyLastResponseToClipboardMsg struct{}

CopyLastResponseToClipboardMsg copies the last assistant response to clipboard.

type CopySessionToClipboardMsg

type CopySessionToClipboardMsg struct{}

CopySessionToClipboardMsg copies the entire conversation to clipboard.

type ElicitationResponseMsg

type ElicitationResponseMsg struct {
	Action  tools.ElicitationAction
	Content map[string]any
}

ElicitationResponseMsg contains response to an elicitation request.

type EvalSessionMsg

type EvalSessionMsg struct{ Filename string }

EvalSessionMsg saves evaluation data to the specified file.

type ExitAfterFirstResponseMsg

type ExitAfterFirstResponseMsg struct{}

ExitAfterFirstResponseMsg exits TUI after first assistant response completes.

type ExitSessionMsg

type ExitSessionMsg struct{}

ExitSessionMsg requests exiting the current session.

type ExportSessionMsg

type ExportSessionMsg struct{ Filename string }

ExportSessionMsg exports the session to the specified file.

type InsertFileRefMsg

type InsertFileRefMsg struct{ FilePath string }

InsertFileRefMsg inserts @filepath reference into editor.

type LoadSessionMsg

type LoadSessionMsg struct{ SessionID string }

LoadSessionMsg loads a session by ID.

type MCPPromptMsg

type MCPPromptMsg struct {
	PromptName string
	Arguments  map[string]string
}

MCPPromptMsg executes an MCP prompt with arguments.

type NewSessionMsg

type NewSessionMsg struct{}

NewSessionMsg requests creation of a new session.

type OpenModelPickerMsg

type OpenModelPickerMsg struct{}

OpenModelPickerMsg opens the model picker dialog.

type OpenSessionBrowserMsg

type OpenSessionBrowserMsg struct{}

OpenSessionBrowserMsg opens the session browser dialog.

type OpenThemePickerMsg

type OpenThemePickerMsg struct{}

OpenThemePickerMsg opens the theme picker dialog.

type OpenURLMsg

type OpenURLMsg struct{ URL string }

OpenURLMsg opens a URL in the browser.

type RegenerateTitleMsg

type RegenerateTitleMsg struct{}

RegenerateTitleMsg regenerates the session title using the AI.

type SendAttachmentMsg

type SendAttachmentMsg struct{ Content *session.Message }

SendAttachmentMsg is a message for the first message with an attachment.

type SendMsg

type SendMsg struct {
	Content     string            // Full content sent to the agent (with file contents expanded)
	Attachments map[string]string // Map of filename to content for attachments
}

SendMsg contains the content sent to the agent.

type SetSessionTitleMsg

type SetSessionTitleMsg struct{ Title string }

SetSessionTitleMsg sets the session title to specified value.

type ShowCostDialogMsg

type ShowCostDialogMsg struct{}

ShowCostDialogMsg shows the cost/usage dialog.

type ShowMCPPromptInputMsg

type ShowMCPPromptInputMsg struct {
	PromptName string
	PromptInfo any // mcptools.PromptInfo but avoiding import cycles
}

ShowMCPPromptInputMsg shows input dialog for MCP prompt.

type ShowPermissionsDialogMsg

type ShowPermissionsDialogMsg struct{}

ShowPermissionsDialogMsg shows the permissions dialog.

type SpeakTranscriptMsg

type SpeakTranscriptMsg struct{ Delta string }

SpeakTranscriptMsg contains transcription delta from speech-to-text.

type StartShellMsg

type StartShellMsg struct{}

StartShellMsg starts an interactive shell.

type StartSpeakMsg

type StartSpeakMsg struct{}

StartSpeakMsg starts speech-to-text transcription.

type StopSpeakMsg

type StopSpeakMsg struct{}

StopSpeakMsg stops speech-to-text transcription.

type StreamCancelledMsg

type StreamCancelledMsg struct{ ShowMessage bool }

StreamCancelledMsg notifies components that the stream has been cancelled.

type SwitchAgentMsg

type SwitchAgentMsg struct{ AgentName string }

SwitchAgentMsg switches to a different agent.

type ThemeCancelPreviewMsg

type ThemeCancelPreviewMsg struct {
	OriginalRef string // Theme reference to restore
}

ThemeCancelPreviewMsg cancels theme preview and restores original.

type ThemeChangedMsg

type ThemeChangedMsg struct{}

ThemeChangedMsg notifies components that the theme has changed (for cache invalidation).

type ThemeFileChangedMsg

type ThemeFileChangedMsg struct {
	ThemeRef string // The theme ref that was modified
}

ThemeFileChangedMsg notifies TUI that the theme file was modified on disk (hot reload). The TUI should load and apply the theme on the main goroutine to avoid race conditions.

type ThemePreviewMsg

type ThemePreviewMsg struct {
	ThemeRef    string // Theme reference to preview
	OriginalRef string // Original theme to restore on cancel
}

ThemePreviewMsg previews a theme without committing.

type ToggleHideToolResultsMsg

type ToggleHideToolResultsMsg struct{}

ToggleHideToolResultsMsg toggles hiding of tool results.

type ToggleSessionStarMsg

type ToggleSessionStarMsg struct{ SessionID string }

ToggleSessionStarMsg toggles star on a session; empty ID means current session.

type ToggleSidebarMsg

type ToggleSidebarMsg struct{}

ToggleSidebarMsg toggles sidebar visibility.

type ToggleThinkingMsg

type ToggleThinkingMsg struct{}

ToggleThinkingMsg toggles extended thinking mode.

type ToggleYoloMsg

type ToggleYoloMsg struct{}

ToggleYoloMsg toggles YOLO mode (auto-approve tools).