root

Documentation

Index

• Constants
• func AddCommand(cmds ...*cobra.Command)
• func Cobra() *cobra.Command
• func Errored()
• func Errorf(spec string, args ...interface{})
• func GetErrorCount() int
• func Start()

Constants

const StaticProgramName = "character"

Functions

func AddCommand

func AddCommand(cmds ...*cobra.Command)

AddCommand is the hook used by our sub-commands to register themselves into our CLI dispatch system. Per-module init() hooks should use this.

func Cobra

func Cobra() *cobra.Command

Cobra exposes the root-level cobra object

func Errored

func Errored()

Errored bumps an error count, used to determine if the main program should exit false or not.

func Errorf

func Errorf(spec string, args ...interface{})

Errorf is a convenience for errors from other commands so that things are consistent instead of importing fmt and os all over the place

func GetErrorCount

func GetErrorCount() int

GetErrorCount is intended for use by main(), to determine how to exit.

func Start

func Start()

Start is the entry-point used by main(), after all the sub-modules have registered their availability via AddCommand calls in their init functions.