tui

Documentation

Overview

Package tui provides a BubbleTea-based terminal user interface for interactive search, exploration, and document viewing of the markedup knowledge graph.

Index

• func Run(idx *index.KnowledgeIndex, kbDir string, cfg *config.Config) error
• type Model
  • func NewModel(idx *index.KnowledgeIndex, kbDir string, cfg *config.Config) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string

Functions

func Run

func Run(idx *index.KnowledgeIndex, kbDir string, cfg *config.Config) error

Run launches the TUI with the given knowledge index, KB directory, and config. It returns an error if stdout is not a terminal or if the TUI encounters a fatal error. The TUI package has no dependency on cobra — it receives only the index, directory, and config.

Types

type Model

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

Model is the top-level BubbleTea model that composes all views.

func NewModel

func NewModel(idx *index.KnowledgeIndex, kbDir string, cfg *config.Config) Model

NewModel creates the root TUI model from a loaded knowledge index. If the index has zero pages, the onboarding screen is shown first. Otherwise, the home/menu screen is shown.

func (Model) Init

func (m Model) Init() tea.Cmd

Init implements tea.Model.

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update implements tea.Model.

func (Model) View

func (m Model) View() string

View implements tea.Model.