cmd

Documentation

Index

• Constants
• func AskPassword(question string) string
• func AskPasswordOnce(question string) string
• func CancelableWait(rawOp any, progress *ProgressRenderer) error
• func FormatSection(header string, content string) string
• func RenderTable(format string, header []string, data [][]string, raw any) error
• type Asker
  • func NewAsker(reader *bufio.Reader) Asker
  • func (a *Asker) AskBool(question string, defaultAnswer string) (bool, error)
  • func (a *Asker) AskChoice(question string, choices []string, defaultAnswer string) (string, error)
  • func (a *Asker) AskInt(question string, min int64, max int64, defaultAnswer string, ...) (int64, error)
  • func (a *Asker) AskString(question string, defaultAnswer string, validate func(string) error) (string, error)
• type ByNameAndType
  • func (a ByNameAndType) Len() int
  • func (a ByNameAndType) Less(i, j int) bool
  • func (a ByNameAndType) Swap(i, j int)
• type Column
• type ProgressRenderer
  • func (p *ProgressRenderer) Done(msg string)
  • func (p *ProgressRenderer) Update(status string)
  • func (p *ProgressRenderer) UpdateOp(op api.Operation)
  • func (p *ProgressRenderer) UpdateProgress(progress ioprogress.ProgressData)
  • func (p *ProgressRenderer) Warn(status string, timeout time.Duration)
• type SortColumnsNaturally
  • func (a SortColumnsNaturally) Len() int
  • func (a SortColumnsNaturally) Less(i, j int) bool
  • func (a SortColumnsNaturally) Swap(i, j int)
• type StringList
  • func (a StringList) Len() int
  • func (a StringList) Less(i, j int) bool
  • func (a StringList) Swap(i, j int)

Constants

const (
	TableFormatCSV     = "csv"
	TableFormatJSON    = "json"
	TableFormatTable   = "table"
	TableFormatYAML    = "yaml"
	TableFormatCompact = "compact"
)

Table list format.

Functions

func AskPassword

func AskPassword(question string) string

AskPassword asks the user to enter a password.

func AskPasswordOnce

func AskPasswordOnce(question string) string

AskPasswordOnce asks the user to enter a password.

It's the same as AskPassword, but it won't ask to enter it again.

func CancelableWait

func CancelableWait(rawOp any, progress *ProgressRenderer) error

CancelableWait waits for an operation and cancel it on SIGINT/SIGTERM.

func FormatSection

func FormatSection(header string, content string) string

FormatSection properly indents a text section.

func RenderTable

func RenderTable(format string, header []string, data [][]string, raw any) error

RenderTable renders tabular data in various formats.

Types

type Asker

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

Asker holds a reader for reading input into CLI questions.

func NewAsker

func NewAsker(reader *bufio.Reader) Asker

func (*Asker) AskBool

func (a *Asker) AskBool(question string, defaultAnswer string) (bool, error)

AskBool asks a question and expect a yes/no answer.

func (*Asker) AskChoice

func (a *Asker) AskChoice(question string, choices []string, defaultAnswer string) (string, error)

AskChoice asks the user to select one of multiple options.

func (*Asker) AskInt

func (a *Asker) AskInt(question string, min int64, max int64, defaultAnswer string, validate func(int64) error) (int64, error)

AskInt asks the user to enter an integer between a min and max value.

func (*Asker) AskString

func (a *Asker) AskString(question string, defaultAnswer string, validate func(string) error) (string, error)

AskString asks the user to enter a string, which optionally conforms to a validation function.

type ByNameAndType

type ByNameAndType [][]string

ByNameAndType represents the type for sorting Storage volumes.

func (ByNameAndType) Len

func (a ByNameAndType) Len() int

func (ByNameAndType) Less

func (a ByNameAndType) Less(i, j int) bool

func (ByNameAndType) Swap

func (a ByNameAndType) Swap(i, j int)

type Column

type Column struct {
	Header string

	// DataFunc is a method to retrieve data for this column. The argument to this function will be an element of the
	// "data" slice that is passed into RenderSlice.
	DataFunc func(any) (string, error)
}

Column represents a single column in a table.

type ProgressRenderer

type ProgressRenderer struct {
	Format string
	Quiet  bool
	// contains filtered or unexported fields
}

ProgressRenderer tracks the progress information.

func (*ProgressRenderer) Done

func (p *ProgressRenderer) Done(msg string)

Done prints the final status and prevents any update.

func (*ProgressRenderer) Update

func (p *ProgressRenderer) Update(status string)

Update changes the status message to the provided string.

func (*ProgressRenderer) UpdateOp

func (p *ProgressRenderer) UpdateOp(op api.Operation)

UpdateOp is a helper to update the status using a REST API operation.

func (*ProgressRenderer) UpdateProgress

func (p *ProgressRenderer) UpdateProgress(progress ioprogress.ProgressData)

UpdateProgress is a helper to update the status using an iopgress instance.

func (*ProgressRenderer) Warn

func (p *ProgressRenderer) Warn(status string, timeout time.Duration)

Warn shows a temporary message instead of the status.

type SortColumnsNaturally

type SortColumnsNaturally [][]string

SortColumnsNaturally represents the type for sorting columns in a natural order from left to right.

func (SortColumnsNaturally) Len

func (a SortColumnsNaturally) Len() int

func (SortColumnsNaturally) Less

func (a SortColumnsNaturally) Less(i, j int) bool

func (SortColumnsNaturally) Swap

func (a SortColumnsNaturally) Swap(i, j int)

type StringList

type StringList [][]string

StringList represents the type for sorting nested string lists.

func (StringList) Len

func (a StringList) Len() int

func (StringList) Less

func (a StringList) Less(i, j int) bool

func (StringList) Swap

func (a StringList) Swap(i, j int)