installprogress

package
v1.49.3 Latest Latest
Warning

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

 Go to latest Published: Oct 13, 2026 License: GPL-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package installprogress presents shell-owned installer state. It never runs installation operations or decides their outcome.

Index

Constants

View Source 
const Capability = "installer-progress-v1"
View Source 
const SessionCapability = "installer-progress-session-v1"

Variables

This section is empty.

Functions

func Promotion added in v1.49.3 

func Promotion(out io.Writer) error

Promotion is trusted static presentation. It never observes installer output.

func Run 

func Run(ctx context.Context, path string, options Options) error

Run observes one existing, regular, append-only event file until stop or context cancellation. Reads and pending line storage are bounded. Malformed events fail the observer without echoing their contents to the terminal.

func RunSession added in v1.49.3 

func RunSession(ctx context.Context, path string, options Options) (err error)

RunSession folds the captured startup prefix before painting one current frame. A separate stop control ends this observer, never the install session.

Types

type Options 

type Options struct {
	Output        io.Writer
	Rich          bool
	Width         int
	Interval      time.Duration
	OwnerPID      int
	Transient     bool
	TerminalWidth func() int
	Height        int
	TerminalSize  func() (int, int)
	Activity      string
	ActivityLimit int
	StopFile      string
}

Options controls presentation only. Rich must be selected by the caller after checking its output terminal. Width is measured in terminal columns.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.