tui

Documentation

Overview

Package tui is the full-screen terminal interface: three panes, live updates.

Index

• func Run(ctx context.Context, st *store.Store, th theme.Theme, about About, ...) error
• type About

Functions

func Run

func Run(ctx context.Context, st *store.Store, th theme.Theme, about About, captureContent bool) error

Run starts the TUI and blocks until quit or ctx cancellation.

Types

type About

type About struct {
	Version  string
	DBPath   string
	OTLP     string // endpoint accepting traces, empty when none bound
	OTLPErr  string // why nothing bound, or which transport was lost
	Watching string // session directory being tailed, empty when none
}

About is what this process can tell the user about itself: the build, where it is writing, and which ways in are actually open. The empty state is built from it, so someone who just installed capybara is told what to do next.