cli

Documentation

Overview

Making CLI commands have some quality without too much boilerplate.

Index

• func AddLogLevelControls(flags *pflag.FlagSet)
• func Execute(app *cobra.Command)
• func Runner(run func(ctx context.Context, args []string, logger *log.Logger) error) func(*cobra.Command, []string)
• func RunnerNoArgs(run func(ctx context.Context, logger *log.Logger) error) func(*cobra.Command, []string)
• func WrapRun(run func(ctx context.Context, args []string) error) func(*cobra.Command, []string)

Functions

func AddLogLevelControls

func AddLogLevelControls(flags *pflag.FlagSet)

adds CLI flags that control the logging level

func Execute

func Execute(app *cobra.Command)

wraps the `Execute()` call of the command to inject boilerplate details like `Use`, `Version` and handling of error to `Command.Execute()` (such as flag validation, missing command etc.)

func Runner

func Runner(run func(ctx context.Context, args []string, logger *log.Logger) error) func(*cobra.Command, []string)

func RunnerNoArgs

func RunnerNoArgs(run func(ctx context.Context, logger *log.Logger) error) func(*cobra.Command, []string)

func WrapRun

func WrapRun(run func(ctx context.Context, args []string) error) func(*cobra.Command, []string)

fixes problems of cobra commands' bare run callbacks with regards to application quality: 1. logging not configured 2. no interrupt handling 3. no error handling