cmd

Documentation

Index

• func Command(obj Runnable, children ...any) *cobra.Command
• func Main(cmd *cobra.Command)
• func Name(obj any) string
• func RequestShutdown() bool
• func SetupSignalContext() context.Context
• func SetupSignalHandler() <-chan struct{}
• type Customizer
• type PersistentPreRunnable
• type PreRunnable
• type Runnable

Functions

func Command

func Command(obj Runnable, children ...any) *cobra.Command

Command populates a cobra.Command object by extracting args from struct tags of the Runnable obj passed. The Run method is assigned to the RunE of the command. children should be either Runnable or *cobra.Command

func Main

func Main(cmd *cobra.Command)

func Name

func Name(obj any) string

func RequestShutdown

func RequestShutdown() bool

RequestShutdown emulates a received event that is considered as shutdown signal (SIGTERM/SIGINT) This returns whether a handler was notified

func SetupSignalContext

func SetupSignalContext() context.Context

SetupSignalContext is same as SetupSignalHandler, but a context.Context is returned. Only one of SetupSignalContext and SetupSignalHandler should be called, and only can be called once.

func SetupSignalHandler

func SetupSignalHandler() <-chan struct{}

SetupSignalHandler registered for SIGTERM and SIGINT. A stop channel is returned which is closed on one of these signals. If a second signal is caught, the program is terminated with exit code 1. Only one of SetupSignalContext and SetupSignalHandler should be called, and only can be called once.

Types

type Customizer

type Customizer interface {
	Customize(cmd *cobra.Command)
}

type PersistentPreRunnable

type PersistentPreRunnable interface {
	PersistentPre(cmd *cobra.Command, args []string) error
}

type PreRunnable

type PreRunnable interface {
	Pre(cmd *cobra.Command, args []string) error
}

type Runnable

type Runnable interface {
	Run(cmd *cobra.Command, args []string) error
}