tui

Documentation

Overview

Package tui implements the interactive terminal dashboard for portctl.

Index

• func HelpEntries() []struct{ ... }
• func RenderGroupHeader(g ProcessGroup, width int, selected bool) string
• func RenderTableHeader(width int) string
• func RenderTableRow(e *scanner.PortEntry, width int, selected bool) string
• func SortEntries(entries []scanner.PortEntry, col SortColumn)
• type Config
• type DetailModel
  • func (d *DetailModel) View(height int) string
• type FilterModel
  • func (f *FilterModel) Apply(entries []scanner.PortEntry) []scanner.PortEntry
  • func (f *FilterModel) View(totalCount, matchCount int) string
• type KeyMap
  • func DefaultKeyMap() KeyMap
• type Model
  • func NewModel(s scanner.PortScanner, k *killer.DefaultKiller, cfg Config) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type ProcessGroup
  • func GroupByProcess(entries []scanner.PortEntry) []ProcessGroup
• type SortColumn
  • func NextSortColumn(c SortColumn) SortColumn
  • func (s SortColumn) String() string

Functions

func HelpEntries

func HelpEntries() []struct{ Key, Desc string }

HelpEntries returns ordered help text for the help overlay.

func RenderGroupHeader

func RenderGroupHeader(g ProcessGroup, width int, selected bool) string

RenderGroupHeader renders one collapsed group row: "node (5 ports: 3000, 3001, 5173, 5174, 8080)"

func RenderTableHeader

func RenderTableHeader(width int) string

RenderTableHeader returns the styled header row.

func RenderTableRow

func RenderTableRow(e *scanner.PortEntry, width int, selected bool) string

RenderTableRow returns a styled row for a single entry.

func SortEntries

func SortEntries(entries []scanner.PortEntry, col SortColumn)

SortEntries sorts entries by the given column.

Types

type Config

type Config struct {
	DockerClient docker.Client
	Interval     time.Duration
}

Config holds TUI configuration.

type DetailModel

type DetailModel struct {
	Entry   *scanner.PortEntry
	Visible bool
}

DetailModel holds the detail panel state.

func (*DetailModel) View

func (d *DetailModel) View(height int) string

View renders the detail panel for the selected entry.

type FilterModel

type FilterModel struct {
	Input  string
	Active bool
}

FilterModel holds the state of the inline filter bar.

func (*FilterModel) Apply

func (f *FilterModel) Apply(entries []scanner.PortEntry) []scanner.PortEntry

Apply returns only entries matching the filter text. Matches against port number (prefix) or process name (substring, case-insensitive).

func (*FilterModel) View

func (f *FilterModel) View(totalCount, matchCount int) string

View renders the filter bar.

type KeyMap

type KeyMap struct {
	Up      key.Binding
	Down    key.Binding
	Filter  key.Binding
	Escape  key.Binding
	Enter   key.Binding
	Kill    key.Binding
	Sort    key.Binding
	Group   key.Binding
	Refresh key.Binding
	Help    key.Binding
	Quit    key.Binding
	Yes     key.Binding
	No      key.Binding
}

KeyMap holds all keybindings for the TUI.

func DefaultKeyMap

func DefaultKeyMap() KeyMap

DefaultKeyMap returns the standard keybindings.

type Model

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

Model is the top-level bubbletea model for the TUI dashboard.

func NewModel

func NewModel(s scanner.PortScanner, k *killer.DefaultKiller, cfg Config) Model

NewModel creates a new TUI model.

func (Model) Init

func (m Model) Init() tea.Cmd

Init starts the first scan and the tick timer.

func (Model) Update

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

Update handles all messages.

func (Model) View

func (m Model) View() string

View renders the entire TUI.

type ProcessGroup

type ProcessGroup struct {
	Name    string
	Entries []scanner.PortEntry
}

ProcessGroup is a set of entries collapsed under one process name.

func GroupByProcess

func GroupByProcess(entries []scanner.PortEntry) []ProcessGroup

GroupByProcess collapses entries by process name, preserving order of first appearance.

type SortColumn

type SortColumn int

SortColumn identifies which column the table is sorted by.

const (
	SortPort SortColumn = iota
	SortPID
	SortProcess
	SortUser
	SortUptime
)

Sort column constants.

func NextSortColumn

func NextSortColumn(c SortColumn) SortColumn

NextSortColumn cycles to the next sort column.

func (SortColumn) String

func (s SortColumn) String() string

String returns the display label for a sort column.