commands

Documentation

Index

• Constants
• Variables
• func Add(app Application, parent *cobra.Command, builder ...CommandBuilder)
• func Confirm(message string) bool
• func ConfirmDeletion(kind string, item fmt.Stringer) bool
• func FormatAndIndent(text string, indent int) string
• func FormatExamples(examples string) string
• func FormatHelp(help string) string
• func Print(out console.Writer, val interface{}) error
• func PrintStdout(val interface{}) error
• func Run(app Application)
• func WaitForOrder(ctx context.Context, action string, ordering common.Ordering) (common.Order, error)
• type Application
• type CommandBuilder
• type ModuleFactory

Constants

const (
	FlagEndpoint = "endpoint"
	FlagToken    = "token"
	FlagDump     = "dump"
	FlagDryRun   = "dry-run"
	FlagFormat   = "format"
)

const (
	FormatJSON  = "json"
	FormatTable = "table"
	FormatCSV   = "csv"
)

Variables

var (
	Stdout = console.NewConsoleOutput(os.Stdout)
	Stderr = console.NewConsoleOutput(os.Stderr)
)

var Config config

var Root = cobra.Command{}

Functions

func Add

func Add(app Application, parent *cobra.Command, builder ...CommandBuilder)

func Confirm

func Confirm(message string) bool

func ConfirmDeletion

func ConfirmDeletion(kind string, item fmt.Stringer) bool

func FormatAndIndent

func FormatAndIndent(text string, indent int) string

func FormatExamples

func FormatExamples(examples string) string

func FormatHelp

func FormatHelp(help string) string

func Print

func Print(out console.Writer, val interface{}) error

func PrintStdout

func PrintStdout(val interface{}) error

func Run

func Run(app Application)

func WaitForOrder

func WaitForOrder(ctx context.Context, action string, ordering common.Ordering) (common.Order, error)

Types

type Application

type Application struct {
	Name        string
	Description string
	Version     string
	Endpoint    string

	Modules []ModuleFactory
}

type CommandBuilder

type CommandBuilder interface {
	Build(app Application) *cobra.Command
}

type ModuleFactory

type ModuleFactory func(app Application) *cobra.Command