ui

Documentation

Index

• Constants
• Variables
• func FormatDuration(d time.Duration) string
• func FormatSize(bytes int64) string
• func FormatSkillSummary(info *SkillResultInfo) string
• func GetProgressMessage(toolName string, args string) string
• func RenderCompactHeader(meta ResultMetadata) string
• func RenderCompactResult(result ToolResult) string
• func RenderErrorHeader(toolName, errorMsg string, width int) string
• func RenderFileList(files []string, maxShow int) string
• func RenderGrepResults(lines []ContentLine, maxShow int) string
• func RenderHeader(meta ResultMetadata, width int) string
• func RenderLines(lines []ContentLine, showLineNo bool) string
• func RenderProgress(spinnerFrame string, message string) string
• func RenderToolResult(result ToolResult, width int) string
• func TruncateText(text string, maxLen int) string
• type ContentLine
• type LineType
• type ResultMetadata
• type SkillResultInfo
• type ToolResult
  • func NewErrorResult(title, errorMsg string) ToolResult
  • func NewSuccessResult(title, icon, subtitle string, size int64, lineCount, itemCount int, ...) ToolResult
  • func (r ToolResult) FormatForLLM() string

Constants

const (
	IconRead     = "\U0001F4C4" // 📄
	IconGlob     = "\U0001F50D" // 🔍
	IconGrep     = "\U0001F50E" // 🔎
	IconWeb      = "\U0001F310" // 🌐
	IconSearch   = "\U0001F50D" // 🔍 (web search)
	IconError    = "\u274C"     // ❌
	IconSuccess  = "\u2713"     // ✓
	IconFile     = "\U0001F4C1" // 📁
	IconDuration = "\u23F1"     // ⏱
)

Icons

const MaxLineLength = 500

MaxLineLength is the maximum length of a content line

Variables

var (
	ColorSuccess = lipgloss.Color("#10B981") // green
	ColorError   = lipgloss.Color("#EF4444") // red
	ColorMuted   = lipgloss.Color("#6B7280") // gray
	ColorAccent  = lipgloss.Color("#60A5FA") // blue
	ColorWarn    = lipgloss.Color("#F59E0B") // yellow
	ColorMatch   = lipgloss.Color("#FBBF24") // yellow (highlight match)
	ColorBorder  = lipgloss.Color("#374151") // dark gray for borders
)

Colors

var (
	// Header box styles
	HeaderStyle = lipgloss.NewStyle().
				BorderStyle(lipgloss.RoundedBorder()).
				BorderForeground(ColorBorder).
				Padding(0, 1)

	HeaderTitleStyle = lipgloss.NewStyle().
						Bold(true).
						Foreground(ColorAccent)

	HeaderSubtitleStyle = lipgloss.NewStyle().
						Foreground(lipgloss.Color("#E5E7EB"))

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

	// Content styles
	LineNumberStyle = lipgloss.NewStyle().
					Foreground(ColorMuted).
					Width(5).
					Align(lipgloss.Right)

	LineContentStyle = lipgloss.NewStyle()

	MatchStyle = lipgloss.NewStyle().
				Foreground(ColorMatch).
				Bold(true)

	FilePathStyle = lipgloss.NewStyle().
					Foreground(ColorAccent)

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

	// Error styles
	ErrorStyle = lipgloss.NewStyle().
				Foreground(ColorError)

	ErrorMsgStyle = lipgloss.NewStyle().
					Foreground(lipgloss.Color("#FCA5A5"))

	// Progress styles
	SpinnerStyle = lipgloss.NewStyle().
					Foreground(ColorWarn)

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

Styles

var SpinnerFrames = []string{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"}

SpinnerFrames contains the spinner animation frames

Functions

func FormatDuration

func FormatDuration(d time.Duration) string

FormatDuration formats duration to human readable string

func FormatSize

func FormatSize(bytes int64) string

FormatSize formats bytes to human readable size

func FormatSkillSummary

func FormatSkillSummary(info *SkillResultInfo) string

FormatSkillSummary formats the skill result summary for display

Examples:

Loaded: git:commit [2 scripts, 1 ref]
Loaded: pdf [3 scripts]
Loaded: my-skill

func GetProgressMessage

func GetProgressMessage(toolName string, args string) string

GetProgressMessage returns the appropriate progress message for a tool

func RenderCompactHeader

func RenderCompactHeader(meta ResultMetadata) string

RenderCompactHeader renders a single-line header for compact display 📄 Read: /path/to/file.go (2.4 KB · 85 lines · 12ms)

func RenderCompactResult

func RenderCompactResult(result ToolResult) string

RenderCompactResult renders a compact single-line result

func RenderErrorHeader

func RenderErrorHeader(toolName, errorMsg string, width int) string

RenderErrorHeader renders an error header box ┌─ Read ──────────────────────────────────────┐ │ ❌ Error │ │ file not found: /path/to/missing.go │ └─────────────────────────────────────────────┘

func RenderFileList

func RenderFileList(files []string, maxShow int) string

RenderFileList renders a list of file paths

src/main.go
src/utils/helper.go

func RenderGrepResults

func RenderGrepResults(lines []ContentLine, maxShow int) string

RenderGrepResults renders grep search results

main.go:42: // TODO: fix this
utils.go:15: // TODO: refactor

func RenderHeader

func RenderHeader(meta ResultMetadata, width int) string

RenderHeader renders the tool header box ┌─ Read ──────────────────────────────────────┐ │ 📄 /path/to/file.go │ │ 2.4 KB · 85 lines · 12ms │ └─────────────────────────────────────────────┘

func RenderLines

func RenderLines(lines []ContentLine, showLineNo bool) string

RenderLines renders content lines with optional line numbers

1│package main
2│
3│import "fmt"

func RenderProgress

func RenderProgress(spinnerFrame string, message string) string

RenderProgress renders an in-progress state ⠋ Reading file... ⠙ Searching 42 files... ⠹ Fetching https://example.com...

func RenderToolResult

func RenderToolResult(result ToolResult, width int) string

RenderToolResult renders a complete tool result with header and content

func TruncateText

func TruncateText(text string, maxLen int) string

TruncateText truncates text to maxLen with ellipsis

Types

type ContentLine

type ContentLine struct {
	LineNo int      // Line number (0 means no line number)
	Text   string   // Line content
	Type   LineType // Line type
	File   string   // File path (for grep results)
}

ContentLine represents a formatted content line

type LineType

type LineType int

LineType represents the type of content line

const (
	LineNormal    LineType = iota // Normal line
	LineMatch                     // Matched line (highlight)
	LineHeader                    // File header
	LineTruncated                 // Truncated indicator
)

type ResultMetadata

type ResultMetadata struct {
	Title      string        // Tool name
	Icon       string        // Tool icon
	Subtitle   string        // Short description (e.g., file path)
	Size       int64         // File/content size in bytes
	Duration   time.Duration // Execution duration
	LineCount  int           // Number of lines
	ItemCount  int           // Number of items (files/matches)
	StatusCode int           // HTTP status code (WebFetch)
	Truncated  bool          // Whether output was truncated
}

ResultMetadata contains metadata about tool execution result

type SkillResultInfo

type SkillResultInfo struct {
	SkillName   string // Full skill name (namespace:name)
	ScriptCount int    // Number of scripts in skill
	RefCount    int    // Number of reference files
}

SkillResultInfo contains skill-specific result metadata for custom rendering

type ToolResult

type ToolResult struct {
	Success   bool             // Whether the tool succeeded
	Output    string           // Main output content
	Error     string           // Error message if failed
	Metadata  ResultMetadata   // Result metadata
	Lines     []ContentLine    // Formatted content lines (optional)
	Files     []string         // File list (for Glob)
	SkillInfo *SkillResultInfo // Skill-specific info (for Skill tool)
}

ToolResult represents the result of a tool execution

func NewErrorResult

func NewErrorResult(title, errorMsg string) ToolResult

NewErrorResult creates an error result

func NewSuccessResult

func NewSuccessResult(title, icon, subtitle string, size int64, lineCount, itemCount int, duration time.Duration) ToolResult

NewSuccessResult creates a success result with metadata

func (ToolResult) FormatForLLM

func (r ToolResult) FormatForLLM() string

FormatForLLM returns a plain text representation of the result for LLM consumption