cmd

Documentation

Index

• func Execute()
• func NewRootCMD() *cobra.Command
• func Run(cmd *cobra.Command, v *viper.Viper)
• func RunCmd(v *viper.Viper, verbose bool, sendDiagsOnErrors bool, cmd cmdFn, ...)
• func RunCmdWithOfflineSync(v *viper.Viper, verbose bool, sendDiagsOnErrors bool, cmd cmdFn, ...)
• func SetupLogging(v *viper.Viper) (*logfile.Params, 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 Run

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

Run executes commands parsed from a command line.

func RunCmd

func RunCmd(v *viper.Viper, verbose bool, sendDiagsOnErrors bool, cmd cmdFn, shutdown shutdownFn)

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(v *viper.Viper, verbose bool, sendDiagsOnErrors bool, cmd cmdFn, shutdown shutdownFn)

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 SetupLogging

func SetupLogging(v *viper.Viper) (*logfile.Params, error)

SetupLogging uses the --log-file param to configure logging to file or stdout.