ui

package

v0.0.28 Latest Latest Go to latest Published: Nov 20, 2025 License: Apache-2.0 Imports: 26 Imported by: 2

Documentation ¶

Index ¶

type TUI
- func NewTUI(agent *agent.Agent) *TUI
- func (u *TUI) ClearScreen()
- func (u *TUI) Run(ctx context.Context) error
type TerminalUI
- func NewTerminalUI(agent *agent.Agent, useTTYForInput bool, showToolOutput bool, ...) (*TerminalUI, error)
type Type
type UI

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type TUI ¶ added in v0.0.16

type TUI struct {
	// contains filtered or unexported fields
}

TUI is a rich terminal user interface for the agent.

func NewTUI ¶ added in v0.0.16

func NewTUI(agent *agent.Agent) *TUI

func (*TUI) ClearScreen ¶ added in v0.0.16

func (u *TUI) ClearScreen()

func (*TUI) Run ¶ added in v0.0.16

func (u *TUI) Run(ctx context.Context) error

type TerminalUI ¶

type TerminalUI struct {
	// contains filtered or unexported fields
}

TODO: rename this to CLI because the command line interface.

func NewTerminalUI ¶

func NewTerminalUI(agent *agent.Agent, useTTYForInput bool, showToolOutput bool, journal journal.Recorder) (*TerminalUI, error)

func (*TerminalUI) ClearScreen ¶

func (u *TerminalUI) ClearScreen()

func (*TerminalUI) Close ¶ added in v0.0.2

func (u *TerminalUI) Close() error

func (*TerminalUI) Run ¶ added in v0.0.16

func (u *TerminalUI) Run(ctx context.Context) error

type Type ¶ added in v0.0.16

type Type string

Type is the type of user interface.

const (
	UITypeTerminal Type = "terminal"
	UITypeWeb      Type = "web"
	UITypeTUI      Type = "tui"
)

func (*Type) Set ¶ added in v0.0.16

func (u *Type) Set(s string) error

Implement pflag.Value for UIType

func (*Type) String ¶ added in v0.0.16

func (u *Type) String() string

func (*Type) Type ¶ added in v0.0.16

func (u *Type) Type() string

type UI ¶

type UI interface {
	// ClearScreen clears any output rendered to the screen
	ClearScreen()

	// Run starts the UI and blocks until the context is done.
	Run(ctx context.Context) error
}

UI is the interface that defines the capabilities of assisant's user interface. Each of the UIs, CLI, TUI, Web, etc. implement this interface.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
html

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