cmd

Documentation

Overview

Package cmd provides a common utilities and helper function to standarise the way omni apps use cobra and viper to produce consistent cli experience for both users and devs.

Index

• func BindHomeFlag(flags *pflag.FlagSet, homeDir *string)
• func LogFlags(ctx context.Context, flags *pflag.FlagSet) error
• func Main(cmd *cobra.Command)
• func NewRootCmd(appName string, appDescription string, subCmds ...*cobra.Command) *cobra.Command
• func SilenceErrUsage(cmd *cobra.Command)

Functions

func BindHomeFlag

func BindHomeFlag(flags *pflag.FlagSet, homeDir *string)

BindHomeFlag binds the home flag to the given flag set. This is generally only required for apps that require multiple config files or persist data to disk. Using this flag will result in the viper config directory to be updated from default "." to "<home>/config".

func LogFlags

func LogFlags(ctx context.Context, flags *pflag.FlagSet) error

LogFlags logs the configured flags kv pairs.

func Main

func Main(cmd *cobra.Command)

Main is the main entry point for the command line tool. Usage:

   func main() {
	     libcmd.Main(appcmd.New())
   }

func NewRootCmd

func NewRootCmd(appName string, appDescription string, subCmds ...*cobra.Command) *cobra.Command

NewRootCmd returns a new root cobra command that handles our command line tool. It sets up the general viper config and binds the cobra flags to the viper flags. It also silences the usage printing when commands error during "running".

func SilenceErrUsage

func SilenceErrUsage(cmd *cobra.Command)

SilenceErrUsage silences the usage and error printing.