cmdutil

Documentation

Index

• Constants
• func AddWaitFlags(cmd *cobra.Command)
• func ExactArgs(n int) cobra.PositionalArgs
• func FormatBytes(bytes int64) string
• func FormatOutput(cmd *cobra.Command, data any) error
• func GetFormat(cmd *cobra.Command) string
• func NewClient(cmd *cobra.Command) (*api.Client, error)
• func WaitFor(cfg WaitConfig, checkFn func() (done bool, status string, err error)) error
• type WaitConfig
  • func GetWaitConfig(cmd *cobra.Command, resource string) *WaitConfig

Constants

const (
	DefaultWaitInterval = 10 * time.Second
	DefaultWaitTimeout  = 5 * time.Minute
)

Functions

func AddWaitFlags

func AddWaitFlags(cmd *cobra.Command)

AddWaitFlags adds --wait and --wait-timeout flags to a command.

func ExactArgs

func ExactArgs(n int) cobra.PositionalArgs

ExactArgs returns a PositionalArgs that reports the command's Use line on mismatch.

func FormatBytes

func FormatBytes(bytes int64) string

FormatBytes formats a byte count as a human-readable string.

func FormatOutput

func FormatOutput(cmd *cobra.Command, data any) error

FormatOutput applies filter, sort, and formats data to stdout.

func GetFormat

func GetFormat(cmd *cobra.Command) string

GetFormat returns the output format from flags.

func NewClient

func NewClient(cmd *cobra.Command) (*api.Client, error)

NewClient creates an API client from the cobra command context.

func WaitFor

func WaitFor(cfg WaitConfig, checkFn func() (done bool, status string, err error)) error

WaitFor polls checkFn until it returns done=true or an error occurs. checkFn returns (done, status, error):

• done=true: success, stop polling
• done=false: keep polling, print status
• err!=nil: abort with error

Types

type WaitConfig

type WaitConfig struct {
	Interval time.Duration
	Timeout  time.Duration
	Resource string // e.g. "server my-server"
}

WaitConfig holds parameters for the polling loop.

func GetWaitConfig

func GetWaitConfig(cmd *cobra.Command, resource string) *WaitConfig

GetWaitConfig reads --wait and --wait-timeout flags from the command. Returns nil if --wait is not set.