cmdline

Documentation

Index

• func Display(ctx context.Context, app string, summaries <-chan *builder.Summary, ...)
• type Option
  • func DefaultOpts() Option
  • func NoColor() Option
  • func WithBuildID(buildID string) Option
  • func WithStderr(w io.Writer) Option
  • func WithStdout(w io.Writer) Option

Functions

func Display

func Display(ctx context.Context, app string, summaries <-chan *builder.Summary, opts ...Option)

Display provides a UI for the draft client. When performing a draft 'up' Display will output a measure of progress for each summary yielded by the draft state machine.

Types

type Option

type Option func(*options)

Option defines a configurable cmdline interface option.

func DefaultOpts

func DefaultOpts() Option

DefaultOpts is a convenience wrapper that enumerates and configures the set of default

options for the cmdline interface.

func NoColor

func NoColor() Option

NoColor returns an Option that sets if the output is colorized or not.

Colorized output is enabled by default.

func WithBuildID

func WithBuildID(buildID string) Option

WithBuildID returns an Option that set the build id to use.

func WithStderr

func WithStderr(w io.Writer) Option

WithStderr returns an Option that sets the cmdline interface's stderr writer.

Defaults to os.Stderr.

func WithStdout

func WithStdout(w io.Writer) Option

WithStdout returns an Option that sets the cmdline interface's stdout writer.

Defaults to os.Stdout.