feat: Implement a modern terminal UI using Bubble Tea framework to replace the legacy readline-based interface, providing better user experience with split-pane layout for chat and tool events.

Author: Zerofisher

CHANGELOG.md

@@ -26,7 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Breaking**: Replaced custom HTTP implementation with official SDKs
 - **API**: Updated `llm.Client` interface for better provider abstraction
 - **Configuration**: Enhanced config support for multiple providers
-- **Default Model**: OpenAI default model changed to `gpt-4.1-mimi`
+- **Default Model**: OpenAI default model changed to `gpt-4.1-mini`
 - **Dependencies**:
   - Added `github.com/openai/openai-go/v2 v2.7.1`
   - Added `github.com/anthropics/anthropic-sdk-go v1.14.0`
@@ -98,7 +98,7 @@ model:
 ```yaml
 model:
   provider: "openai" # or "anthropic"
-  name: "gpt-4.1-mimi" # for OpenAI
+  name: "gpt-4.1-mini" # for OpenAI
   # name: "claude-3-7-sonnet-latest"  # for Anthropic
 ```
 

README.md

@@ -122,11 +122,13 @@ go build ./cmd/goai
 1. **Set up your API key** (required for LLM features):
 
 For OpenAI:
+
 ```bash
 export OPENAI_API_KEY="your-api-key-here"
 ```
 
 For Anthropic:
+
 ```bash
 export ANTHROPIC_API_KEY="your-api-key-here"
 ```
@@ -167,6 +169,36 @@ Type your query or command and press Enter.
 >
 ```
 
+### TUI (Bubble Tea)
+
+GoAI includes a full-screen TUI built with Bubble Tea. It shows assistant replies and real-time tool events side by side.
+
+- Run
+  - Default: `./goai` launches the TUI.
+  - Fallback legacy prompt: set `GOAI_LEGACY_UI=1` to use the old readline interface.
+
+- Layout
+  - Left panel: conversation (assistant/user), with streaming updates.
+  - Right panel: tool events and outputs (started/succeeded/failed with truncated output).
+  - Bottom: input line; top/right: spinner status (e.g., “Running bash…”, “Thinking…”).
+
+- Keys
+  - `Enter`: send the current input
+  - `Esc`: cancel the current request
+  - `Ctrl+C`: quit
+
+- Tool Events
+  - Tools executed by the agent emit events in real time:
+    - started: tool name and sanitized arguments
+    - succeeded: duration + output (long output truncated)
+    - failed: error message
+  - Events do not alter conversation history; they are for visibility only.
+
+- Configuration (optional)
+  - Configure model/provider via `goai.yaml` or env vars (see below).
+  - Tool event output length is limited internally to keep the UI responsive.
+  - To force the legacy prompt temporarily: `GOAI_LEGACY_UI=1 ./goai`.
+
 ### Usage Examples
 
 #### Example 1: Create a Simple Program
@@ -250,10 +282,11 @@ export OPENAI_BASE_URL="https://api.openai.com/v1"  # API endpoint (default: Ope
 For advanced configuration, create a `goai.yaml` file in your project directory or `~/.config/goai/config.yaml`:
 
 **OpenAI Configuration:**
+
 ```yaml
 model:
   provider: "openai"
-  name: "gpt-4.1-mimi"  # or "gpt-4", "gpt-3.5-turbo", etc.
+  name: "gpt-4.1-mini" # or "gpt-4", "gpt-3.5-turbo", etc.
   max_tokens: 16000
   timeout: 60
 
@@ -279,10 +312,11 @@ output:
 ```
 
 **Anthropic Configuration:**
+
 ```yaml
 model:
   provider: "anthropic"
-  name: "claude-3-7-sonnet-latest"  # or "claude-3-opus-latest", etc.
+  name: "claude-3-7-sonnet-latest" # or "claude-3-opus-latest", etc.
   max_tokens: 16000
   timeout: 60
 

cmd/goai/main.go

@@ -10,8 +10,10 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/Zerofisher/goai/cmd/goai/tui"
 	"github.com/Zerofisher/goai/pkg/agent"
 	"github.com/Zerofisher/goai/pkg/config"
+	"github.com/Zerofisher/goai/pkg/dispatcher"
 	"github.com/Zerofisher/goai/pkg/reminder"
 	"github.com/Zerofisher/goai/pkg/todo"
 	"github.com/Zerofisher/goai/pkg/tools/bash"
@@ -20,6 +22,8 @@ import (
 	"github.com/Zerofisher/goai/pkg/tools/search"
 	todotool "github.com/Zerofisher/goai/pkg/tools/todo"
 
+	tea "github.com/charmbracelet/bubbletea"
+
 	// Import LLM providers to register their factories
 	_ "github.com/Zerofisher/goai/pkg/llm/anthropic"
 	_ "github.com/Zerofisher/goai/pkg/llm/openai"
@@ -68,11 +72,18 @@ func main() {
 		fmt.Println()
 	}
 
-	// Print welcome message
-	printWelcome()
-
-	// Run interactive loop
-	runInteractiveLoop(ctx, agent)
+	// Check if we should use legacy interactive mode
+	// Set GOAI_LEGACY_UI=1 to use the old readline-based interface
+	useLegacyUI := os.Getenv("GOAI_LEGACY_UI") == "1"
+
+	if useLegacyUI {
+		// Use legacy interactive mode
+		printWelcome()
+		runInteractiveLoop(ctx, agent)
+	} else {
+		// Use Bubble Tea TUI
+		runTUI(ctx, agent, cfg)
+	}
 }
 
 // loadConfig loads the configuration from file or environment
@@ -265,4 +276,40 @@ func printHelp() {
 	fmt.Println("  - The agent can help with code generation, debugging, and explanations")
 	fmt.Println("  - Use available tools to read/write files and execute commands")
 	fmt.Println()
-}
+}
+
+// runTUI starts the Bubble Tea TUI interface
+func runTUI(_ context.Context, a *agent.Agent, cfg *config.Config) {
+	// Create TUI model
+	model := tui.New(a, cfg)
+
+	// Create Bubble Tea program
+	p := tea.NewProgram(
+		model,
+		tea.WithAltScreen(),       // Use alternate screen buffer
+		tea.WithMouseCellMotion(), // Enable mouse support
+	)
+
+	// Set program reference in model (for goroutine message sending)
+	model.SetProgram(p)
+
+	// Configure tool observer with events options
+	eventsOpts := dispatcher.EventsOptions{
+		MaxOutputChars: cfg.Output.ToolOutputMaxChars,
+		MaskKeys: []string{
+			"api_key", "apikey", "token", "password", "passwd", "pwd",
+			"secret", "auth", "key", "access_key", "private_key",
+			"authorization", "credential", "credentials",
+		},
+	}
+
+	// Register observer with the agent
+	observer := tui.NewObserver(p)
+	a.SetToolObserver(observer, eventsOpts)
+
+	// Start the program
+	if _, err := p.Run(); err != nil {
+		fmt.Printf("Error starting TUI: %v\n", err)
+		os.Exit(1)
+	}
+}

cmd/goai/tui/model.go

@@ -0,0 +1,83 @@
+package tui
+
+import (
+	"github.com/Zerofisher/goai/pkg/agent"
+	"github.com/Zerofisher/goai/pkg/config"
+	"github.com/charmbracelet/bubbles/spinner"
+	"github.com/charmbracelet/bubbles/textinput"
+	"github.com/charmbracelet/bubbles/viewport"
+	tea "github.com/charmbracelet/bubbletea"
+)
+
+// Model represents the state of the TUI application
+type Model struct {
+	// Agent reference for executing queries
+	agent *agent.Agent
+
+	// Configuration
+	cfg *config.Config
+
+	// Program reference (for sending messages from goroutines)
+	program *tea.Program
+
+	// UI Components
+	input    textinput.Model // Bottom input field
+	chat     viewport.Model  // Left/top viewport for conversation
+	tools    viewport.Model  // Right/bottom viewport for tool events
+	spinner  spinner.Model   // Loading spinner
+
+	// State
+	state struct {
+		querying bool   // Whether a query is in progress
+		ready    bool   // Whether the UI is ready (window size received)
+		width    int    // Terminal width
+		height   int    // Terminal height
+	}
+
+	// Content buffers
+	chatContent  string // Accumulated chat messages
+	toolsContent string // Accumulated tool event logs
+
+	// Spinner state
+	spinnerLabel string // Current spinner label text
+}
+
+// New creates a new TUI model
+func New(a *agent.Agent, cfg *config.Config) *Model {
+	// Create text input
+	ti := textinput.New()
+	ti.Placeholder = "Type your message..."
+	ti.Focus()
+	ti.CharLimit = 500
+	ti.Width = 50
+
+	// Create spinner
+	s := spinner.New()
+	s.Spinner = spinner.Dot
+	s.Style = defaultSpinnerStyle()
+
+	m := &Model{
+		agent:        a,
+		cfg:          cfg,
+		input:        ti,
+		spinner:      s,
+		spinnerLabel: "Ready",
+	}
+
+	m.state.ready = false
+	m.state.querying = false
+
+	// Initial content
+	m.chatContent = "Welcome to GoAI Coder!\n\n"
+	m.toolsContent = "Tool events will appear here...\n\n"
+
+	return m
+}
+
+// Init initializes the model (Bubble Tea interface)
+func (m *Model) Init() tea.Cmd {
+	return tea.Batch(
+		textinput.Blink,
+		m.spinner.Tick,
+	)
+}

cmd/goai/tui/msgs.go

@@ -0,0 +1,28 @@
+package tui
+
+import (
+	"github.com/Zerofisher/goai/pkg/types"
+)
+
+// ToolEventMsg wraps a tool event for the Bubble Tea message loop
+type ToolEventMsg struct {
+	Event types.ToolEvent
+}
+
+// LLMStreamTextMsg contains a chunk of streaming text from the LLM
+type LLMStreamTextMsg struct {
+	Text string
+}
+
+// LLMDoneMsg signals that the LLM has finished generating a response
+type LLMDoneMsg struct{}
+
+// ErrorMsg wraps an error for display in the UI
+type ErrorMsg struct {
+	Err error
+}
+
+// QueryMsg triggers a query to the agent
+type QueryMsg struct {
+	Text string
+}

cmd/goai/tui/observer.go

@@ -0,0 +1,29 @@
+package tui
+
+import (
+	"context"
+
+	"github.com/Zerofisher/goai/pkg/types"
+	tea "github.com/charmbracelet/bubbletea"
+)
+
+// Observer implements dispatcher.ToolObserver and sends tool events to the Bubble Tea program
+type Observer struct {
+	program *tea.Program
+}
+
+// NewObserver creates a new observer that sends events to the given Bubble Tea program
+func NewObserver(p *tea.Program) *Observer {
+	return &Observer{
+		program: p,
+	}
+}
+
+// OnToolEvent implements dispatcher.ToolObserver
+// It sends the tool event as a message to the Bubble Tea event loop
+func (o *Observer) OnToolEvent(_ context.Context, e types.ToolEvent) {
+	if o.program != nil {
+		// Non-blocking send to the Bubble Tea message loop
+		o.program.Send(ToolEventMsg{Event: e})
+	}
+}

cmd/goai/tui/styles.go

@@ -0,0 +1,60 @@
+package tui
+
+import (
+	"github.com/charmbracelet/lipgloss"
+)
+
+var (
+	// Color palette
+	colorPrimary   = lipgloss.Color("#00D7AF")
+	colorSecondary = lipgloss.Color("#7D56F4")
+	colorError     = lipgloss.Color("#FF5F87")
+	colorSubtle    = lipgloss.Color("#6C7086")
+	colorBorder    = lipgloss.Color("#45475A")
+
+	// Base styles
+	baseStyle = lipgloss.NewStyle().
+			Padding(0, 1)
+
+	// Title styles
+	titleStyle = lipgloss.NewStyle().
+			Foreground(colorPrimary).
+			Bold(true).
+			Padding(0, 1)
+
+	// Viewport styles
+	viewportStyle = lipgloss.NewStyle().
+			BorderStyle(lipgloss.RoundedBorder()).
+			BorderForeground(colorBorder).
+			Padding(1, 2)
+
+	// Input styles
+	inputStyle = lipgloss.NewStyle().
+			BorderStyle(lipgloss.RoundedBorder()).
+			BorderForeground(colorPrimary).
+			Padding(0, 1)
+
+	// Spinner styles
+	spinnerStyle = lipgloss.NewStyle().
+			Foreground(colorSecondary)
+
+	// Status bar style
+	statusBarStyle = lipgloss.NewStyle().
+			Foreground(colorSubtle).
+			Padding(0, 1)
+
+	// Tool event styles
+	toolStartedStyle = lipgloss.NewStyle().
+				Foreground(lipgloss.Color("#FFA500"))
+
+	toolSucceededStyle = lipgloss.NewStyle().
+				Foreground(lipgloss.Color("#00FF00"))
+
+	toolFailedStyle = lipgloss.NewStyle().
+				Foreground(colorError)
+)
+
+// defaultSpinnerStyle returns the default spinner style
+func defaultSpinnerStyle() lipgloss.Style {
+	return spinnerStyle
+}