tui

type AddModelMsg ¶

type AddModelMsg struct{}

AddModelMsg signals that the user wants to add a new model via setup wizard

type AgentDoneMsg ¶

type AgentDoneMsg struct{ Err error }

type AgentMode ¶

type AgentMode int

AgentMode represents the agent's operational mode.

const (
	ModeNormal    AgentMode = iota // Default mode
	ModePlanning                   // Plan mode — read-only exploration
	ModeExecuting                  // Executing an approved plan
)

type AgentTextMsg ¶

type AgentTextMsg struct{ Text string }

type AgentsMdMsg ¶

type AgentsMdMsg struct {
	Found bool
	Path  string
}

AgentsMdMsg is sent by the main goroutine to notify TUI that agents.md was loaded.

type ApprovalMode ¶

type ApprovalMode int

ApprovalMode represents the approval mode state

const (
	ModeManual ApprovalMode = iota // Manual approval mode (default)
	ModeAuto                       // Auto-approve mode
)

type AskUserQuestionMsg ¶

type AskUserQuestionMsg struct {
	Question string
	Options  []string // optional selectable choices
}

AskUserQuestionMsg is sent when the agent asks the user a question via ask_user tool.

type AskUserResponse ¶

type AskUserResponse struct {
	Answer string
}

AskUserResponse is the user's answer to an ask_user question.

type BLECommandMsg ¶ added in v0.3.4

type BLECommandMsg struct {
	Cmd string // "input", "submit", "cancel"
	Val string // payload for "input" command
}

BLECommandMsg is sent when a command is received from a BLE device.

type BatchRenderMsg ¶ added in v0.4.10

type BatchRenderMsg struct{}

BatchRenderMsg is sent by the stream debounce timer to batch-flush accumulated AgentTextMsg content into a single viewport refresh.

type BgTaskDoneMsg ¶

type BgTaskDoneMsg struct {
	TaskID  string
	Command string
	Status  string
	Output  string
}

BgTaskDoneMsg is sent when a background task completes.

type ChannelAction ¶ added in v0.1.1

type ChannelAction struct {
	ChannelID string // "wechat"
	Action    string // "login", "logout", "enable", "disable"
}

ChannelAction represents an action the user wants to perform on a channel.

type ChannelInboundMsg ¶ added in v0.1.1

type ChannelInboundMsg struct {
	ChannelID string
	From      string
	Text      string
}

ChannelInboundMsg is sent when an inbound message arrives from a channel.

type ChannelQRCodeMsg ¶ added in v0.1.1

type ChannelQRCodeMsg struct {
	ChannelID     string
	QRCodeURL     string // image data or URL
	QRCodeContent string // raw content to encode as terminal QR
	Message       string
}

ChannelQRCodeMsg is sent when a QR code is available for scanning.

type ChannelStateMsg ¶ added in v0.1.1

type ChannelStateMsg struct {
	ChannelID string // "wechat"
	State     string // "none", "disabled", "enabled"
	Message   string // status message (e.g. "connected", "scanning...")
}

ChannelStateMsg is sent from the main goroutine to update channel state display in TUI.

type CompactDoneMsg ¶

type CompactDoneMsg struct {
	OldTokens int64
	NewTokens int64
	Err       error
}

CompactDoneMsg is sent when context compaction completes.

type CompactRequestMsg ¶

type CompactRequestMsg struct{}

CompactRequestMsg is sent when the user requests manual context compaction.

type ConfigUpdatedMsg ¶

type ConfigUpdatedMsg struct {
	Provider string
	Model    string
	Message  string
}

ConfigUpdatedMsg is sent when the provider/model configuration is updated via setup wizard

type ExitTimeoutMsg ¶

type ExitTimeoutMsg struct{}

ExitTimeoutMsg is sent after 5s to clear exit confirmation

type MCPNoticeMsg ¶ added in v0.5.2

type MCPNoticeMsg struct {
	Text string
}

MCPNoticeMsg is sent from the main goroutine to surface an MCP status line (login progress, errors) in the TUI transcript.

type MCPStatusItem ¶

type MCPStatusItem struct {
	Name      string
	ToolCount int
	Running   bool
	ErrMsg    string
	// NeedsAuth is true when the server requires OAuth login before its tools
	// become available (use /mcp to log in).
	NeedsAuth bool
}

type MCPStatusMsg ¶

type MCPStatusMsg struct {
	Statuses []MCPStatusItem
}

type Mode ¶

type Mode int

const (
	ModeAgent Mode = iota
)

type ModeSelectedMsg ¶ added in v0.5.0

type ModeSelectedMsg struct {
	Mode mode.SessionMode
}

ModeSelectedMsg is sent from the main goroutine back to the TUI to sync the mode pill after the backend changes the session mode programmatically (resume restore, plan-completion revert, or echoing a Shift+Tab change).

type Model ¶

type Model struct {

	// OnApprovalModeChange is called when the user promotes to auto-approve via the
	// approval dialog's "Approve All". It updates the backend ApprovalState's
	// approval axis directly (no agent rebuild), which is the correct fast path for
	// a mid-run approval-only change. The unified Shift+Tab selector instead flows
	// through modeSelectCh so it can also swap tools/prompt.
	OnApprovalModeChange func(enabled bool)
	// contains filtered or unexported fields
}

func NewModel(hasPrompt bool, pwd string, todoStore *tools.TodoStore) Model

func RunTUI(hasPrompt bool, pwd string, todoStore *tools.TodoStore, opts ...ModelOption) (*tea.Program, Model)

func (m *Model) Init() tea.Cmd

func (m *Model) SetTeamManager(manager *team.Manager)

func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (m *Model) View() tea.View

type ModelOption ¶ added in v0.3.2

type ModelOption func(*Model)

ModelOption configures a Model before the BubbleTea program starts.

func WithApprovalModeChange(fn func(bool)) ModelOption

func WithGoalStore(gs *tools.GoalStore) ModelOption

func WithStartupMode(sm mode.SessionMode) ModelOption

func WithTheme(name string) ModelOption

func WithVersion(v string) ModelOption

type PasteStore ¶ added in v0.3.7

type PasteStore struct {
	// contains filtered or unexported fields
}

PasteStore stores multi-line content and provides reference-based access. It is used to collapse long pasted content in the TUI while preserving the full content for the agent.

func NewPasteStore() *PasteStore

func (ps *PasteStore) Clear()

func (ps *PasteStore) ExpandRefs(input string) string

func (ps *PasteStore) Get(id int) (string, bool)

func (ps *PasteStore) Store(content string) int

func (ps *PasteStore) StoreAndFormat(content string) string

type PlanApprovalMsg ¶

type PlanApprovalMsg struct {
	PlanContent string
	PlanPath    string
}

PlanApprovalMsg is sent when the agent wants to show a plan for approval.

type PlanApprovedMsg ¶

type PlanApprovedMsg struct{}

PlanApprovedMsg is sent when the user approves a plan.

type PlanRejectedMsg ¶

type PlanRejectedMsg struct {
	Feedback string
}

PlanRejectedMsg is sent when the user rejects a plan.

type PlanResponse ¶

type PlanResponse struct {
	Approved bool
	Feedback string // non-empty on rejection
}

PlanResponse is the user's response to a plan approval.

type PromptSubmitMsg ¶

type PromptSubmitMsg struct{ Prompt string }

type ProviderProfile ¶

type ProviderProfile struct {
	ID           string
	Name         string
	BaseURL      string
	NeedURL      bool // if true, prompt for custom URL
	NeedKey      bool // if true, prompt for API Key
	FromRegistry bool // true if provider exists in models.dev
}

ProviderProfile holds the minimal info needed for the setup wizard flow.

type ResumeRequestMsg ¶

type ResumeRequestMsg struct{ UUID string }

ResumeRequestMsg is sent when the user requests to resume a session by UUID.

type SSHCancelMsg ¶

type SSHCancelMsg struct{}

SSHCancelMsg is sent when user cancels the SSH dir picker via Esc.

type SSHConnectMsg ¶

type SSHConnectMsg struct {
	Addr string // user@host
	Path string // remote working dir (optional)
}

SSHConnectMsg is sent when user initially requests connection

type SSHDirResultsMsg ¶

type SSHDirResultsMsg struct {
	Path  string
	Items []string
	Err   error
}

SSHDirResultsMsg is sent from main to TUI with directory contents

type SSHListDirReqMsg ¶

type SSHListDirReqMsg struct {
	Path string
}

SSHListDirReqMsg is sent when TUI needs to list a directory on the remote machine

type SSHStatusMsg ¶

type SSHStatusMsg struct {
	Success bool
	Label   string // e.g. "root@myserver:22"
	Err     error
}

SSHStatusMsg carries the result of an SSH connection attempt.

type SessionEntry ¶

type SessionEntry struct {
	Type         string
	Content      string
	Name         string
	Args         string
	Output       string
	Error        string
	ToolCallID   string
	SubagentName string
	SubagentType string

	// Plan fields
	PlanStatus  string
	PlanTitle   string
	PlanContent string
	Feedback    string

	// Todo fields
	Todos []TodoSnapshotItem

	// Mode change
	Mode string

	// Compact fields
	Summary    string
	CompactedN int
}

SessionEntry is a display-ready record from a replayed session.

func ConvertSessionEntries(entries []session.Entry) []SessionEntry

type SessionResumedMsg ¶

type SessionResumedMsg struct {
	UUID    string
	Entries []SessionEntry
}

SessionResumedMsg is sent by the main goroutine to replay a session in the TUI.

type SetupDoneMsg ¶

type SetupDoneMsg struct{}

type SetupModel ¶

type SetupModel struct {
	// contains filtered or unexported fields
}

func NewSetupModel() SetupModel

func (m SetupModel) Init() tea.Cmd

func (m SetupModel) IsDone() bool

func (m SetupModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (m SetupModel) View() tea.View

type SetupState ¶

type SetupState int

const (
	StateProvider SetupState = iota
	StateModel
	StateCustomModel
	StateURL
	StateAPIKey
)

type SidebarComponent ¶ added in v0.3.5

type SidebarComponent struct{}

SidebarComponent renders the right-hand info panel.

func NewSidebarComponent() *SidebarComponent

func (s *SidebarComponent) View(state SidebarState) string

type SidebarState ¶ added in v0.3.5

type SidebarState struct {
	Width             int
	Height            int
	TotalWidth        int // full width including borders
	EnvLabel          string
	ActiveProvider    string
	ActiveModel       string
	TotalTokens       int64
	ModelContextLimit int
	TodoItems         []tools.TodoItem
	TodoScrollOffset  int
	MCPStatuses       []MCPStatusItem
	TeammateCount     int
	BgRunning         int
	Version           string
}

SidebarState holds the data needed to render the right sidebar.

type SkillSlashInfo ¶

type SkillSlashInfo struct {
	Slash       string
	Description string
}

SkillSlashInfo describes a skill's slash command for TUI hint display.

type SkillSlashMsg ¶

type SkillSlashMsg struct {
	SkillName string // skill name to load
	UserInput string // additional user input after the slash command
}

SkillSlashMsg is sent when a user triggers a slash command mapped to a skill.

type SkillsLoadedMsg ¶

type SkillsLoadedMsg struct {
	SlashCommands []SkillSlashInfo
}

SkillsLoadedMsg is sent at startup to inform the TUI about available skill slash commands.

type StatusBarComponent ¶

type StatusBarComponent struct {
}

StatusBarComponent is a stateless-like component in Bubble Tea.

func NewStatusBarComponent() *StatusBarComponent

func (s *StatusBarComponent) View(state StatusBarState) string

type StatusBarState ¶

type StatusBarState struct {
	Width             int
	ActiveProvider    string
	ActiveModel       string
	AutoApprove       bool
	TotalTokens       int64
	ModelContextLimit int
	MCPStatuses       []MCPStatusItem
	Mode              AgentMode
	BgRunning         int
	TeammateCount     int
}

StatusBarState holds the props supplied to the StatusBar component

type SubagentDoneMsg ¶

type SubagentDoneMsg struct {
	Name   string
	Result string
	Err    error
}

SubagentDoneMsg is sent when a subagent finishes.

type SubagentProgressMsg ¶

type SubagentProgressMsg struct {
	AgentName string
	Event     string // "tool_call" or "tool_result"
	ToolName  string
	Detail    string
}

SubagentProgressMsg is sent for intermediate subagent events (tool calls / results).

type SubagentStartMsg ¶

type SubagentStartMsg struct {
	Name string
	Type string
}

SubagentStartMsg is sent when a subagent begins executing.

type SubagentTokenUpdateMsg ¶

type SubagentTokenUpdateMsg struct {
	TotalTokens int64 // cumulative tokens used by the subagent since it started
}

SubagentTokenUpdateMsg is sent after each model turn to update the subagent's token usage.

type TeamViewMode ¶

type TeamViewMode int

TeamViewMode represents what the user is viewing.

const (
	TeamViewLeader   TeamViewMode = iota // viewing leader's conversation
	TeamViewTeammate                     // viewing a teammate's conversation
	TeamViewPanel                        // navigating coordinator panel
)

type TeamViewState ¶

type TeamViewState struct {
	Manager       *team.Manager
	ViewingAgent  string // agentID of currently viewed teammate ("" = leader)
	PanelVisible  bool   // show coordinator panel
	PanelSelected int    // selected index in coordinator panel
	ViewMode      TeamViewMode
	Teammates     []*team.TeammateState // cached snapshot

	// Per-teammate display lines, keyed by agentID.
	TeammateLines       map[string][]string
	TeammateCurrentText map[string]*strings.Builder
}

TeamViewState tracks team-related TUI state.

func (t *TeamViewState) AppendTeammateLine(agentID string, lines ...string)

func (t *TeamViewState) AppendTeammateText(agentID, text string)

func (t *TeamViewState) FlushTeammateText(agentID string)

func (t *TeamViewState) GetTeammateDisplayLines(agentID string) []string

func (t *TeamViewState) HasTeam() bool

func (t *TeamViewState) RefreshTeammates()

type TodoSnapshotItem ¶ added in v0.3.3

type TodoSnapshotItem struct {
	ID     int    `json:"id"`
	Title  string `json:"title"`
	Status string `json:"status"`
}

TodoSnapshotItem mirrors session.TodoSnapshotItem for TUI display.

type TodoUpdateMsg ¶

type TodoUpdateMsg struct{}

TodoUpdateMsg signals that the todo store has been updated.

type TokenUpdateMsg ¶

type TokenUpdateMsg struct {
	TotalTokens       int64
	ModelContextLimit int // 0 if unknown
}

TokenUpdateMsg is sent periodically to update token usage display

type ToolApprovalRequestMsg ¶

type ToolApprovalRequestMsg struct {
	Name        string
	Args        string
	Resp        chan ToolApprovalResponse
	IsExternal  bool   // Whether this is an external path access (for read tool)
	WorkerName  string // Non-empty when approval is from a teammate (e.g. "@backend")
	WorkerColor string // Teammate's color for TUI display
}

ToolApprovalRequestMsg is sent when a tool needs user approval

type ToolApprovalResponse ¶

type ToolApprovalResponse struct {
	Approved bool
	Mode     ApprovalMode // Mode after this response (stay MANUAL or switch to AUTO)
}

ToolApprovalResponse is the user's response to a tool approval request

type ToolCallMsg ¶

type ToolCallMsg struct {
	Name     string
	Args     string
	Title    string // human-readable tool name (e.g. "Read", "Shell")
	Subtitle string // context info (file path, description)
}

type ToolResultMsg ¶

type ToolResultMsg struct {
	Name, Output string
	Err          error
}

type UserPromptMsg ¶

type UserPromptMsg struct{ Prompt string }