tui

package
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 25, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ColorAccent      = lipgloss.Color("#7C6FE0") // soft purple, secondary accent
	ColorPrimary     = lipgloss.Color("#4EC9B0") // primary brand color
	ColorPrimarySoft = lipgloss.Color("108")     // muted primary used for borders/section labels
	ColorUser        = lipgloss.Color("#5FAFFF") // bright blue
	ColorAssistant   = lipgloss.Color("#C792EA") // soft purple/magenta
	ColorTool        = lipgloss.Color("#FFCB6B") // amber/yellow
	ColorError       = lipgloss.Color("#FF5370") // soft red
	ColorSuccess     = lipgloss.Color("#C3E88D") // green
	ColorMuted       = lipgloss.Color("243")     // medium gray
	ColorThinking    = lipgloss.Color("240")     // dim gray, distinctly muted vs assistant text
	ColorToken       = lipgloss.Color("249")     // light gray
	ColorCommand     = lipgloss.Color("#89DDFF") // cyan
	ColorStatusBg    = lipgloss.Color("236")     // dark background
	ColorSeparator   = lipgloss.Color("243")     // medium gray
	ColorBorder      = lipgloss.Color("246")
	ColorShell       = lipgloss.Color("#FF79C6") // pink/magenta for shell mode
)

Color palette — dark terminal optimized.

View Source
var (
	ToolIconStyle = lipgloss.NewStyle().Foreground(ColorTool)

	ToolNameStyle = lipgloss.NewStyle().Foreground(ColorTool).Bold(true)

	ToolArgsStyle = lipgloss.NewStyle().Foreground(ColorMuted)

	ToolResultStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("246"))

	ToolPathStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("#82AAFF"))
)

Tool blocks

View Source
var (
	WelcomeTitleStyle = lipgloss.NewStyle().Foreground(ColorAccent).Bold(true)

	WelcomeDetailStyle = lipgloss.NewStyle().Foreground(ColorMuted)
)

Welcome banner

View Source
var (
	ChoiceActiveStyle   = lipgloss.NewStyle().Foreground(ColorAccent).Bold(true)
	ChoiceInactiveStyle = lipgloss.NewStyle().Foreground(ColorMuted)
)

Selection menu (plan approval, etc.)

View Source
var (
	CommandPaletteStyle = lipgloss.NewStyle().
						Border(lipgloss.RoundedBorder()).
						BorderForeground(ColorPrimarySoft)

	CommandPaletteTitleStyle = lipgloss.NewStyle().
								Foreground(lipgloss.Color("250")).
								Bold(true)

	CommandPaletteSectionStyle = lipgloss.NewStyle().
								Foreground(ColorPrimarySoft).
								Bold(true)

	CommandPaletteSelectedStyle = lipgloss.NewStyle().
								Foreground(ColorPrimary).
								Bold(true)

	CommandPaletteItemStyle = lipgloss.NewStyle().
							Foreground(lipgloss.Color("252"))

	CommandPaletteDescStyle = lipgloss.NewStyle().
							Foreground(lipgloss.Color("249"))

	CommandPaletteSelectedDescStyle = lipgloss.NewStyle().
									Foreground(ColorPrimary)

	CommandPaletteHintStyle = lipgloss.NewStyle().
							Foreground(lipgloss.Color("246"))
)

Command palette

View Source
var (
	MutedStyle = lipgloss.NewStyle().Foreground(ColorMuted)

	BoxBorderStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("245"))

	QueuedMsgStyle = lipgloss.NewStyle().Foreground(ColorMuted).Italic(true)

	TokenStyle = lipgloss.NewStyle().Foreground(ColorToken)

	DiffAddStyle = lipgloss.NewStyle().Foreground(ColorSuccess)

	DiffRemoveStyle = lipgloss.NewStyle().Foreground(ColorError)

	DiffInverseAddStyle = lipgloss.NewStyle().Foreground(ColorSuccess).Reverse(true)

	DiffInverseRemoveStyle = lipgloss.NewStyle().Foreground(ColorError).Reverse(true)

	ReplyLabelStyle = lipgloss.NewStyle().Foreground(ColorAssistant)
)

General purpose

View Source
var AssistantIconStyle = lipgloss.NewStyle().
	Foreground(ColorAssistant).
	Bold(true)

Assistant icon

View Source
var AssistantMarkdownBlockStyle = lipgloss.NewStyle().
	BorderLeft(true).
	BorderForeground(lipgloss.Color("99")).
	Padding(0, 1).
	MarginLeft(1)

Assistant markdown container

View Source
var CommandStyle = lipgloss.NewStyle().
	Foreground(ColorCommand)

Command / system output

View Source
var ErrorStyle = lipgloss.NewStyle().
	Foreground(ColorError).
	Bold(true)

Error

View Source
var FooterStyle = lipgloss.NewStyle().
	Foreground(lipgloss.Color("235")).
	Background(lipgloss.Color("#b5e6b5")).
	Padding(0, 1)

Footer

View Source
var ImageSelectedStyle = lipgloss.NewStyle().Reverse(true)

Image tag selected (reverse video highlight)

View Source
var PlanBoxStyle = lipgloss.NewStyle().
	Border(lipgloss.RoundedBorder()).
	BorderForeground(ColorAccent).
	Padding(0, 1)

Plan box

View Source
var PlanTagStyle = lipgloss.NewStyle().Foreground(ColorPrimary)

Plan mode tag

View Source
var SeparatorStyle = lipgloss.NewStyle().
	Foreground(ColorSeparator)

Separator

View Source
var ShellSeparatorStyle = lipgloss.NewStyle().
	Foreground(ColorShell)

Shell mode separator

View Source
var SubagentCardStyle = lipgloss.NewStyle().
	Border(lipgloss.RoundedBorder()).
	BorderForeground(ColorTool).
	Padding(0, 1)

Subagent result card

View Source
var SystemMsgStyle = lipgloss.NewStyle().
	Foreground(ColorMuted).
	Italic(true)

Short system notifications (e.g. "Switched to model", "Session cleared")

View Source
var ThinkingBodyStyle = lipgloss.NewStyle().
	Foreground(ColorThinking).
	Italic(true)

Thinking body

Functions

func CommandPaletteCategoryBadge added in v0.0.4

func CommandPaletteCategoryBadge(category string) string

func CommandPaletteIdleBadge added in v0.0.2

func CommandPaletteIdleBadge(needsIdle bool) string

func CommandPaletteKindBadge added in v0.0.2

func CommandPaletteKindBadge(kind string) string

func DrawBox added in v0.0.3

func DrawBox(lines []string, innerWidth, fixedRows int) string

DrawBox draws a rounded border box with fixed height and gray border. innerWidth is the content width; fixedRows is the exact number of content rows (short content is padded with empty lines to keep view height stable).

func FormatProgressLine

func FormatProgressLine(result json.RawMessage) string

FormatProgressLine formats a tool progress update for display.

func FormatSubagentOutput

func FormatSubagentOutput(result json.RawMessage) string

FormatSubagentOutput extracts the full output from a subagent result, appending usage stats as a footer. Returns content for card display.

func FormatTokens

func FormatTokens(n int) string

FormatTokens formats a token count with k/M suffix for readability.

func FormatToolArgs

func FormatToolArgs(args json.RawMessage) string

FormatToolArgs formats tool arguments for display, truncating if needed.

func FormatToolHeader added in v0.0.2

func FormatToolHeader(tool string, args json.RawMessage) string

FormatToolHeader returns a one-line tool header like "Bash(git diff --stat)".

func FormatToolOutput added in v0.0.2

func FormatToolOutput(text string, maxVisible int, styles ...lipgloss.Style) string

FormatToolOutput formats tool result text with tree connectors. First line gets "└ ", subsequent lines get " " alignment. Truncates to maxVisible lines with "… +N lines" hint. Optional styles override the default ToolResultStyle for line content.

func FormatToolResult

func FormatToolResult(result json.RawMessage, isError bool) string

FormatToolResult extracts displayable text from a tool result. Truncation is handled by the caller (FormatToolOutput).

func RenderEditResult

func RenderEditResult(result json.RawMessage) string

RenderEditResult renders the edit tool result with colored diff output. Single-line changes (1 removed + 1 added) get intra-line highlighting where only the changed portion is rendered in inverse color.

func RenderLsResult added in v0.0.4

func RenderLsResult(result json.RawMessage) (dirPath string, body string)

RenderLsResult renders ls tool results with tree structure. Returns the directory path (for header update) and the formatted body.

func RenderReadResult added in v0.0.4

func RenderReadResult(result json.RawMessage) string

RenderReadResult renders read/glob tool results with colored line numbers. Handles both numbered lines (" 123\tcontent") and plain path lists.

func RenderStreamingOutput

func RenderStreamingOutput(full string, maxLines int) string

RenderStreamingOutput shows the last N lines of streaming tool output with tree connectors (└ on first line, spaces for alignment).

func RenderWriteResult added in v0.0.2

func RenderWriteResult(result json.RawMessage) string

RenderWriteResult renders the write tool result with a green preview of the written content.

func SendCommandResult

func SendCommandResult(text string) tea.Cmd

SendCommandResult is a helper that wraps text into a CommandResultMsg tea.Cmd.

func TasksTickCmd added in v0.0.3

func TasksTickCmd() tea.Cmd

TasksTickCmd returns a tea.Cmd that fires TasksRefreshMsg after 500ms.

func TruncateLines

func TruncateLines(s string, maxLines int) string

TruncateLines truncates text to maxLines, appending "..." if truncated.

Types

type AgentEventMsg

type AgentEventMsg struct {
	Event agentcore.Event
}

AgentEventMsg bridges agentcore events into the bubbletea Elm loop.

type AskUserMsg

type AskUserMsg struct {
	Questions []tools.Question
	RespCh    chan<- *tools.AskUserResponse
}

AskUserMsg is sent by the AskUser handler to show questions in the TUI.

type BtwResultMsg added in v0.0.4

type BtwResultMsg struct {
	Answer string
	Err    error
}

BtwResultMsg carries the result of a /btw side question back to the overlay.

type CommandResultMsg

type CommandResultMsg struct {
	Text     string
	Quit     bool   // true for /exit
	Clear    bool   // true for /clear
	NewModel string // non-empty if model was switched
}

CommandResultMsg carries the result of a slash command back to the model.

type CompletionItem added in v0.0.2

type CompletionItem struct {
	Name        string // command name without "/" (e.g. "model")
	Description string
	Usage       string
	Kind        string
	Category    string
	NeedsIdle   bool
	Source      string
	Aliases     []string
	AutoExecute bool
}

CompletionItem is a single command completion candidate.

type Config

type Config struct {
	Placeholder      string
	Version          string
	Cwd              string
	GitBranch        string
	EnvHint          string                   // shown below welcome when using env var credentials
	History          *storage.History         // input history (Up/Down navigation)
	RestoredMessages []agentcore.AgentMessage // messages restored from a previous session (rendered on Init)
	OnKey            func(m *Model, msg tea.KeyMsg) (handled bool, cmd tea.Cmd)
	OnEvent          func(m *Model, ev agentcore.Event) tea.Cmd
	OnPaste          func(m *Model) tea.Cmd              // Ctrl+V: read clipboard image, return ImageAttachedMsg
	OnDrop           func(m *Model, text string) tea.Cmd // Drag-drop: if text is image path, return cmd; else nil
	OnMCPReady       func(msg MCPReadyMsg)               // called when MCP servers finish connecting
	StatusRight      func(m *Model) string
	StatusMode       func(m *Model) string // mode indicator for context bar (e.g. "⏵⏵ trust")
	StatusPlan       func(m *Model) *PlanBarInfo
	Overlay          func(m *Model) *OverlayState         // interactive command overlay
	Completions      func(prefix string) []CompletionItem // slash command completions
	OnBtwResult      func(msg BtwResultMsg)               // called when /btw side question completes
}

Config provides hooks for extending the base TUI behavior.

type Driver

type Driver interface {
	Prompt(text string) error
	PromptWithBlocks(blocks []agentcore.ContentBlock) error
	Steer(text string)
	Abort()
}

Driver defines the minimal conversation operations required by the TUI.

type ImageAttachedMsg

type ImageAttachedMsg struct {
	Block agentcore.ContentBlock // pre-built ImageBlock (base64 + mime)
}

ImageAttachedMsg notifies the Model that an image has been pasted from clipboard.

type MCPReadyMsg added in v0.0.3

type MCPReadyMsg struct {
	Tools        int      // total number of tools loaded across all servers
	Errors       []string // connection errors (server: reason)
	Instructions string   // MCP server instructions to set as system suffix
}

MCPReadyMsg notifies the TUI that background MCP server connection has completed.

type Model

type Model struct {
	Driver    Driver
	ModelName string
	Version   string

	Input   textarea.Model
	Spinner spinner.Model

	ToolSpinner spinner.Model // breathing-dot spinner for tool execution

	Streaming *strings.Builder
	Thinking  *strings.Builder
	IsStream  bool

	Running         bool
	TurnCount       int
	PendingTools    map[string]string           // toolID -> tool name
	ToolHeaders     map[string]string           // toolID -> formatted header (printed at end)
	ToolOutputBuf   map[string]*strings.Builder // toolID -> streaming output
	ToolDeltaBuf    map[string]*strings.Builder // toolID -> accumulated subagent delta text
	ToolThinkingBuf map[string]*strings.Builder // toolID -> accumulated subagent thinking text

	Width  int
	Height int
	Ready  bool

	Cwd         string
	GitBranch   string
	ShowWelcome bool
	EnvHint     string // env var hint shown below welcome
	ShowSummary bool
	RunStats    runStats
	Images      []agentcore.ContentBlock // attached images (from Ctrl+V clipboard paste)
	ImageCursor int                      // -1 = not selecting; 0+ = selected image index
	Pasting     int                      // number of async image reads in progress (clipboard paste or drag-drop)

	Markdown *markdown.Renderer

	AskUser    *askUserState    // non-nil when ask-user UI is active
	Permission *permissionState // non-nil when permission prompt is active

	Tasks *tools.TaskSnapshot // non-nil when tasks exist; displayed above input

	QueuedMsgs []string // messages queued while agent is running (display only)

	MCPLoading bool // true while MCP servers are connecting in background

	Suggestion string // prompt suggestion shown as placeholder after agent completes

	QuitPending bool // true after first Ctrl+C, waiting for second to quit
	// contains filtered or unexported fields
}

Model is the bubbletea Model for the agent TUI. Completed content is printed to terminal scrollback via tea.Println; View() only renders the live area (status + streaming + input).

func New

func New(driver Driver, modelName string, cfg ...Config) Model

New creates a Model with the given agent, model name, and optional config.

func (Model) HandleAgentEvent

func (m Model) HandleAgentEvent(ev agentcore.Event) (Model, tea.Cmd)

HandleAgentEvent processes agent events. Completed content is printed to terminal scrollback via tea.Println. In-progress content (streaming, tool output) is shown in the live View().

func (Model) Init

func (m Model) Init() tea.Cmd

Init implements tea.Model.

func (*Model) RenderContextBar

func (m *Model) RenderContextBar() string

RenderContextBar renders the context line below the input (env info).

func (*Model) RenderMarkdown

func (m *Model) RenderMarkdown(content string) string

RenderMarkdown renders markdown content using glamour.

func (*Model) RenderPlanBar

func (m *Model) RenderPlanBar() string

RenderPlanBar renders the plan review card (AskUser-style). Empty when inactive.

func (Model) RenderPromptOutput

func (m Model) RenderPromptOutput(text string) string

RenderPromptOutput renders a user message with optional welcome banner for scrollback.

func (*Model) RenderStatusBar

func (m *Model) RenderStatusBar() string

RenderStatusBar renders the status line above the input. Only shown while the agent is running.

func (Model) Update

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

Update implements tea.Model.

func (Model) View

func (m Model) View() string

View renders the live area pinned at the bottom of the terminal. Completed content lives in terminal scrollback (printed via tea.Println).

type OverlayState added in v0.0.2

type OverlayState struct {
	HandleKey     func(msg tea.KeyMsg) (handled bool, cmd tea.Cmd)
	View          func(width int) string
	ReplacesInput bool // when true, overlay replaces the input area instead of appearing below it
}

OverlayState bridges an interactive command overlay to the TUI.

type PasteErrorMsg

type PasteErrorMsg struct {
	Text string
}

PasteErrorMsg carries an error from clipboard paste or file drag-drop. Decrements Pasting counter and displays the error text.

type PasteTextMsg

type PasteTextMsg struct{}

PasteTextMsg signals that Ctrl+V found no image; the textarea should paste text.

type PermissionDismissMsg added in v0.0.2

type PermissionDismissMsg struct{}

PermissionDismissMsg tells the TUI to close the permission prompt.

type PermissionMsg added in v0.0.2

type PermissionMsg struct {
	Tool         string
	Command      string
	Reason       string
	Preview      string
	OutsideRoots bool // when true, only AllowOnce and Deny are shown
	RespCh       chan<- PermitChoice
}

PermissionMsg is sent to the TUI to show a permission confirmation prompt.

type PermitChoice added in v0.0.2

type PermitChoice int

PermitChoice is the user's response to a permission prompt.

const (
	PermitChoiceDeny         PermitChoice = iota
	PermitChoiceAllowOnce                 // allow this invocation only
	PermitChoiceAllowSession              // allow for the rest of the session
	PermitChoiceAllowAlways               // persist to project config
)

type PlanBarInfo

type PlanBarInfo struct {
	Tag     string   // appended to status bar (e.g., "plan mode")
	Choices []string // selectable options
	Active  int      // active choice index

	// Plan review card fields.
	Prompt    string // e.g., "Would you like to proceed?"
	OtherMode bool   // typing custom feedback
	OtherBuf  string // custom feedback buffer
}

PlanBarInfo provides plan mode status for the status bar.

type PromptMsg

type PromptMsg struct {
	Text string
}

PromptMsg injects a message as if the user typed and sent it. The TUI renders it as a user message and forwards it to the agent.

type RestoreMsg added in v0.0.2

type RestoreMsg struct{ Msgs []agentcore.AgentMessage }

RestoreMsg is sent to replay restored session messages into scrollback.

type SuggestionMsg added in v0.0.4

type SuggestionMsg struct {
	Text string
}

SuggestionMsg carries a prompt suggestion generated after agent completion.

type TaskListUpdateMsg

type TaskListUpdateMsg struct {
	Snapshot tools.TaskSnapshot
}

TaskListUpdateMsg notifies the TUI that the task list has changed.

type TasksRefreshMsg added in v0.0.3

type TasksRefreshMsg struct{}

TasksRefreshMsg is a periodic tick that triggers a re-render of the /tasks overlay.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL