tui

Documentation

Index

• func Run(ctx context.Context, ag *agent.Agent, model, version string, sk []skills.Skill, ...) error
• type ModelChoice
• type Option
  • func WithAfterSend(fn func() error) Option
  • func WithModelChoices(choices []ModelChoice) Option
  • func WithModelSwitcher(provider string, choices []ModelChoice, fn func(ModelChoice) error) Option
  • func WithPermissionMode(mode string) Option
  • func WithSessions(store *session.Store, current *session.Session, ...) 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 string, sk []skills.Skill, options ...Option) error

Run starts the Bubble Tea chat TUI. It returns when the user quits. sk is the loaded skill set used for $name expansion (nil when the feature is off).

Types

type ModelChoice

type ModelChoice struct {
	Provider    string
	ID          string
	Name        string
	Description string
}

type Option

type Option func(*Options)

func WithAfterSend

func WithAfterSend(fn func() error) Option

func WithModelChoices

func WithModelChoices(choices []ModelChoice) Option

func WithModelSwitcher

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

WithModelSwitcher enables provider-aware model selection. The callback must finish the backend switch before returning; the TUI updates its labels only after it succeeds.

func WithPermissionMode

func WithPermissionMode(mode string) Option

func WithSessions

func WithSessions(store *session.Store, current *session.Session, onResume func(*session.Session) error) Option

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 trees 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
	PermissionMode  string
	SessionStore    *session.Store
	CurrentSession  *session.Session
	OnSessionResume func(*session.Session) error
	ModelChoices    []ModelChoice
	Provider        string
	ModelSwitcher   func(ModelChoice) error
	StepEvents      <-chan factory.Event
	WorkflowEvents  <-chan workflow.Event
	Verbose         bool
}