simplecli

Documentation

Overview

Package simplecli is simple CLI framework.

Index

• type CLI
  • func NewCLI() (cli *CLI)
  • func (c *CLI) BindSameName(names ...string) (err error)
  • func (c *CLI) Exit(code int)
  • func (c *CLI) Exit1IfError(err error)
  • func (c *CLI) Initialize() (err error)
  • func (c *CLI) NewCLISetting() CLISetting
  • func (c *CLI) Setup(setups ...func()) (err error)
  • func (c *CLI) StartProfile()
  • func (c *CLI) StopProfile()
• type CLISetting
  • func (c *CLISetting) ConfigFile(path string) func()
  • func (c *CLISetting) ConfigSearchPath(paths ...string) func()

Types

type CLI

type CLI struct {
	Application application

	CommandLine *pflag.FlagSet

	ConfigSearchPath []string
	ConfigFile       string
	Config           *viper.Viper

	Log logif.Logger

	DebugMode   bool
	VerboseMode bool
	ProfileMode string

	InitializeError error
	// contains filtered or unexported fields
}

CLI - CLI main structure

func NewCLI

func NewCLI() (cli *CLI)

NewCLI - New CLI instance.

func (*CLI) BindSameName

func (c *CLI) BindSameName(names ...string) (err error)

BindSameName - Bind viper & pflag parameter.

func (*CLI) Exit

func (c *CLI) Exit(code int)

Exit - Exit CLI application.

func (*CLI) Exit1IfError

func (c *CLI) Exit1IfError(err error)

Exit1IfError - Exit CLI application if error.

func (*CLI) Initialize

func (c *CLI) Initialize() (err error)

Initialize - initialize CLI struct.

func (*CLI) NewCLISetting

func (c *CLI) NewCLISetting() CLISetting

NewCLISetting - New CLISetting instance.

func (*CLI) Setup

func (c *CLI) Setup(setups ...func()) (err error)

Setup - Parse command line & read configuration file.

func (*CLI) StartProfile

func (c *CLI) StartProfile()

StartProfile - Start profiling

func (*CLI) StopProfile

func (c *CLI) StopProfile()

StopProfile - Stop profiling

type CLISetting

type CLISetting struct {
	// contains filtered or unexported fields
}

CLISetting - CLI Setting Structure

func (*CLISetting) ConfigFile

func (c *CLISetting) ConfigFile(path string) func()

ConfigFile - Set ConfigFIle

func (*CLISetting) ConfigSearchPath

func (c *CLISetting) ConfigSearchPath(paths ...string) func()

ConfigSearchPath - Set ConfigSearchPath