progress

package

v2.40.3 Latest Latest Go to latest Published: May 22, 2026 License: MIT Imports: 9 Imported by: 0

Details

This section is empty.

This section is empty.

func OutputDeviceIsTerminal() bool

OutputDeviceIsTerminal returns true if stdout is a terminal.

func ShowIndicator(message string, action func())

ShowIndicator displays a spinner animation while the action executes. In non-terminal environments (CI), it just executes the action without spinner.

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

Spinner displays an animated progress indicator in the terminal.

func NewDefaultSpinner(message string, logger log.Logger) Spinner

NewDefaultSpinner creates a Spinner with default animation characters and timing, writing to stdout.

func NewDefaultSpinnerWithOutput(message string, output io.Writer, logger log.Logger) Spinner

NewDefaultSpinnerWithOutput creates a Spinner with default animation characters and timing.

func NewSpinner(message string, chars []string, delay time.Duration, writer io.Writer, logger log.Logger) Spinner

NewSpinner creates a new Spinner with custom animation characters and timing.

func (s *Spinner) Run(action func())

Run starts the spinner animation and executes the given action. It waits for the action to complete before stopping the spinner.