cli

Documentation

Overview

Package cli consolidates flag and main function handling.

Index

• Variables
• func Run(cmd Command, args []string)
• type Command
• type Common
  • func (c *Common) IsDebug() bool
  • func (c *Common) RunDefaultServeMux()

Variables

var Default = Common{}

Default contains the default flags. Make a copy of this, do not reuse.

Functions

func Run

func Run(cmd Command, args []string)

Run parses the argument and runs the given command. If the ENV_FILE environment variable is set, the files listed in it will be loaded before parsing, to allow for a simple layered configuration setup.

Types

type Command

type Command interface {
	Name() string
	Main(ctx context.Context, args []string)
	IsDebug() bool
	RunDefaultServeMux()
}

Command is a single command that can be parsed and run.

type Common

type Common struct {
	Debug               bool   `long:"debug" env:"HB_DEBUG" description:"Enables debug mode and the debug log level"`
	DefaultServeMuxAddr string `` /* 149-byte string literal not displayed */
}

Common contains flags common to all commands.

func (*Common) IsDebug

func (c *Common) IsDebug() bool

IsDebug returns true if the command should be run in debug mode.

func (*Common) RunDefaultServeMux

func (c *Common) RunDefaultServeMux()

RunDefaultServeMux runs the global default HTTP mux in the background, if the addr has been set.