spinner

Documentation

Overview

Package spinner provides a TTY-aware activity spinner for long-running operations.

Index

• type Spinner
  • func New(label string) *Spinner
  • func (sp *Spinner) Start()
  • func (sp *Spinner) Stop()

Types

type Spinner

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

Spinner wraps briandowns/spinner with TTY awareness.

func New

func New(label string) *Spinner

New creates a spinner that writes to stderr. Returns a no-op spinner when stderr is not a TTY (pipes, CI, redirects).

func (*Spinner) Start

func (sp *Spinner) Start()

Start begins the spinner animation.

func (*Spinner) Stop

func (sp *Spinner) Stop()

Stop halts the spinner and clears it from the terminal.