cmd

Documentation

Index

• func Execute()
• func NewRootCMD() *cobra.Command
• func RunCmd(ctx context.Context, v *viper.Viper, verbose bool, sendDiagsOnErrors bool, ...) error
• func RunCmdWithOfflineSync(ctx context.Context, v *viper.Viper, verbose bool, sendDiagsOnErrors bool, ...) error
• func RunE(cmd *cobra.Command, v *viper.Viper) error
• func SetupLogging(ctx context.Context, v *viper.Viper) (*log.Logger, error)

Functions

func Execute

func Execute()

Execute adds all child commands to the root command sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func NewRootCMD

func NewRootCMD() *cobra.Command

NewRootCMD creates a rootCmd, which represents the base command when called without any subcommands.

func RunCmd

func RunCmd(ctx context.Context, v *viper.Viper, verbose bool, sendDiagsOnErrors bool, cmd cmdFn) error

RunCmd runs a command function and exits with the exit code returned by the command function. Will send diagnostic on any errors or panics.

func RunCmdWithOfflineSync

func RunCmdWithOfflineSync(ctx context.Context, v *viper.Viper, verbose bool, sendDiagsOnErrors bool, cmd cmdFn) error

RunCmdWithOfflineSync runs a command function and exits with the exit code returned by the command function. If command run was successful, it will execute offline sync command afterwards. Will send diagnostic on any errors or panics.

func RunE

func RunE(cmd *cobra.Command, v *viper.Viper) error

RunE executes commands parsed from a command line.

func SetupLogging

func SetupLogging(ctx context.Context, v *viper.Viper) (*log.Logger, error)

SetupLogging uses the --log-file param to configure logging to file or stdout. It returns a logger with the configured settings or the default settings if it's not set.