tui

Documentation

Index

• func Run(ctx context.Context, ag *agent.Agent, model, version, cwd string, ...) error
• type ModelChoice
• type Option
  • func WithAfterSend(fn func() error) Option
  • func WithIO(input io.Reader, output io.Writer) Option
  • func WithModelSwitcher(provider string, choices []ModelChoice, fn func(string) error) Option
  • func WithPhases(definitions []phase.Definition) Option
  • func WithStepEvents(ch <-chan factory.Event) Option
  • func WithVerbose(verbose bool) Option
  • func WithWorkflowEvents(ch <-chan workflow.Event) Option
• type Options

Functions

func Run

func Run(ctx context.Context, ag *agent.Agent, model, version, cwd string, sk []skills.Skill, options ...Option) error

Run starts the Bubble Tea chat TUI. It returns when the user quits. cwd is the effective working directory for display and file references. sk is the loaded skill set used for $name expansion (nil when the feature is off).

Types

type ModelChoice

type ModelChoice struct {
	ID          string
	Name        string
	Description string
}

type Option

type Option func(*Options)

func WithAfterSend

func WithAfterSend(fn func() error) Option

func WithIO

func WithIO(input io.Reader, output io.Writer) Option

WithIO configures the terminal streams used by Bubble Tea. When omitted, Run preserves the standard stdin/stdout behavior.

func WithModelSwitcher

func WithModelSwitcher(provider string, choices []ModelChoice, fn func(string) error) Option

WithModelSwitcher enables model selection for the active provider. The callback must finish the model switch before returning.

func WithPhases

func WithPhases(definitions []phase.Definition) Option

WithPhases supplies the built-in and configured named prompts shown as slash commands and as a compact label for the active turn.

func WithStepEvents

func WithStepEvents(ch <-chan factory.Event) Option

WithStepEvents subscribes the TUI to the factory supervisor's event stream, which the chat view folds into live subagent activity while agent calls execute.

func WithVerbose

func WithVerbose(verbose bool) Option

WithVerbose controls tool activity rendering: false (the default) shows live activity and concise completed receipts while hiding successful tool result bodies; true restores full tool call/result cards. Errors always render in full regardless of this setting.

func WithWorkflowEvents

func WithWorkflowEvents(ch <-chan workflow.Event) Option

type Options

type Options struct {
	AfterSend      func() error
	ModelChoices   []ModelChoice
	Provider       string
	ModelSwitcher  func(string) error
	StepEvents     <-chan factory.Event
	WorkflowEvents <-chan workflow.Event
	Phases         []phase.Definition
	Verbose        bool
	Input          io.Reader
	Output         io.Writer
}