tui

Documentation

Index

• Constants
• Variables
• func Main(options ProgramOptions)
• func NewModel(options ProgramOptions) tea.Model
• type ProgramOptions

Constants

const ApplicationName = "BeatZipper"

ApplicationName contains the application name.

Variables

var ApplicationVersion = "set-during-build"

ApplicationVersion has the version number, and is set during the build.

var (
	// ErrNoFiles is returned when no files were given to extract.
	ErrNoFiles = errors.New("no files given to extract")
)

Functions

func Main

func Main(options ProgramOptions)

Main runs the TUI application.

func NewModel

func NewModel(options ProgramOptions) tea.Model

NewModel returns a new TUI model.

Types

type ProgramOptions

type ProgramOptions struct {
	// The files to extract.
	Files []string

	ExtractionLocation string
}

ProgramOptions can be passed from the CLI to influence how the program behaves.