tui

package
v1.25.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 22, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Launch

func Launch() error

Launch starts the interactive TUI dashboard. It uses the alternate screen buffer so the TUI doesn't pollute scroll-back.

Types

type AppModel

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

AppModel is the root Bubble Tea model.

func NewAppModel

func NewAppModel() AppModel

NewAppModel creates a new TUI model.

func (AppModel) Init

func (m AppModel) Init() tea.Cmd

Init starts the initial data load and refresh ticker.

func (AppModel) Update

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

Update handles messages and key presses.

func (AppModel) View

func (m AppModel) View() string

View renders the TUI.

type KeyMap

type KeyMap struct {
	Start    key.Binding
	Stop     key.Binding
	Restart  key.Binding
	Launch   key.Binding
	Mailpit  key.Binding
	XHGui    key.Binding
	Refresh  key.Binding
	Filter   key.Binding
	Help     key.Binding
	Quit     key.Binding
	Up       key.Binding
	Down     key.Binding
	Enter    key.Binding
	Detail   key.Binding
	Back     key.Binding
	Logs     key.Binding
	SSH      key.Binding
	StartAll key.Binding
	StopAll  key.Binding
	Confirm  key.Binding
	Xdebug   key.Binding
	Poweroff key.Binding
	CopyURL  key.Binding
	Config   key.Binding
	PageUp   key.Binding
	PageDown key.Binding
}

KeyMap defines all key bindings for the TUI.

func DefaultKeyMap

func DefaultKeyMap() KeyMap

DefaultKeyMap returns the default key bindings.

type ProjectDetail

type ProjectDetail struct {
	Name            string
	Status          string
	Type            string
	PHPVersion      string
	WebserverType   string
	NodeJSVersion   string
	Docroot         string
	DatabaseType    string
	DatabaseVersion string
	XdebugEnabled   bool
	PerformanceMode string
	URLs            []string
	MailpitURL      string
	DBPublishedPort string
	Addons          []string
	Services        []ServiceInfo
	AppRoot         string
}

ProjectDetail holds the full detail for a DDEV project (equivalent to `ddev describe`).

type ProjectInfo

type ProjectInfo struct {
	Name    string
	Status  string
	Type    string
	URL     string
	AppRoot string
}

ProjectInfo holds the display-relevant fields for a DDEV project.

type ServiceInfo

type ServiceInfo struct {
	Name   string
	Status string
}

ServiceInfo holds the name and status of a container service.

type Styles

type Styles struct {
	Title       lipgloss.Style
	StatusBar   lipgloss.Style
	HelpKey     lipgloss.Style
	HelpDesc    lipgloss.Style
	Running     lipgloss.Style
	Stopped     lipgloss.Style
	Paused      lipgloss.Style
	ProjectName lipgloss.Style
	ProjectType lipgloss.Style
	URL         lipgloss.Style
	Cursor      lipgloss.Style
	Divider     lipgloss.Style
	HelpOverlay lipgloss.Style
	DetailLabel lipgloss.Style
	DetailValue lipgloss.Style
}

Styles holds all the lipgloss styles used by the TUI.

func NewStyles

func NewStyles() Styles

NewStyles creates styles respecting SimpleFormatting and NO_COLOR.

Jump to

Keyboard shortcuts

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