GoCrab

package
Version: v0.0.0-...-d032931 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 1, 2018 License: GPL-3.0 Imports: 17 Imported by: 0

Documentation

Overview

package GoCrab provides a minimal framework for creating and organizing command line Go applications. cli is designed to be easy to understand and write, the most simple cli application can be written as follows:

func main() {
  cli.NewApp().Run(os.Args)
}

Of course this application does not do much, so let's make this an actual application:

func main() {
  app := cli.NewApp()
  app.Name = "greet"
  app.Usage = "say a greeting"
  app.Action = func(c *cli.Context) {
    println("Greetings")
  }

  app.Run(os.Args)
}
Example
app := cli.NewApp()
app.Name = "todo"
app.Usage = "task list on the command line"
app.Commands = []cli.Command{
	{
		Name:    "add",
		Aliases: []string{"a"},
		Usage:   "add a task to the list",
		Action: func(c *cli.Context) {
			println("added task: ", c.Args().First())
		},
	},
	{
		Name:    "complete",
		Aliases: []string{"c"},
		Usage:   "complete a task on the list",
		Action: func(c *cli.Context) {
			println("completed task: ", c.Args().First())
		},
	},
}

app.Run(os.Args)
Output:

Index

Examples

Constants

View Source
const (
	LevelEmergency = iota
	LevelAlert
	LevelCritical
	LevelError
	LevelWarning
	LevelNotice
	LevelInformational
	LevelDebug
)

Log levels to control the logging output.

View Source
const RUNMODE_DEV = Core.RUNMODE_DEV
View Source
const RUNMODE_PROD = Core.RUNMODE_PROD
View Source
const VERSION = Core.VERSION

Variables

View Source
var (
	CrabApp *App // GoCrab application
	AppName string
	AppPath string
	UseCLI  bool

	AppConfigPath       string
	RecoverPanic        bool // flag of auto recover panic
	AppConfig           *GoCrabAppConfig
	RunMode             string // run mode, "dev" or "prod"
	MaxMemory           int64
	AppConfigProvider   string // config provider
	RouterCaseSensitive bool   // router case sensitive default is true
)
View Source
var AppHelpTemplate = `` /* 416-byte string literal not displayed */

The text template for the Default help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.

View Source
var BashCompletionFlag = BoolFlag{
	Name: "generate-bash-completion",
}

This flag enables bash-completion for all commands and subcommands

View Source
var CommandHelpTemplate = `` /* 242-byte string literal not displayed */

The text template for the command help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.

View Source
var HelpFlag = BoolFlag{
	Name:  "help, h",
	Usage: "show help",
}

This flag prints the help for all commands and subcommands Set to the zero value (BoolFlag{}) to disable flag -- keeps subcommand unless HideHelp is set to true)

View Source
var HelpPrinter helpPrinter = nil
View Source
var Logger *logs.Logger

logger references the used application logger.

View Source
var SubcommandHelpTemplate = `` /* 264-byte string literal not displayed */

The text template for the subcommand help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.

View Source
var VersionFlag = BoolFlag{
	Name:  "version, v",
	Usage: "print the version",
}

This flag prints the version for the application

View Source
var VersionPrinter = printVersion

Prints version for the App

Functions

func Alert

func Alert(v ...interface{})

func Critical

func Critical(v ...interface{})

Critical logs a message at critical level.

func Debug

func Debug(v ...interface{})

Debug logs a message at debug level.

func DefaultAppComplete

func DefaultAppComplete(c *Context)

Prints the list of subcommands as the default app completion method

func Emergency

func Emergency(v ...interface{})

func Error

func Error(v ...interface{})

Error logs a message at error level.

func Info deprecated

func Info(v ...interface{})

Deprecated: compatibility alias for Warning(), Will be removed in 1.5.0.

func Informational

func Informational(v ...interface{})

Info logs a message at info level.

func Notice

func Notice(v ...interface{})

func ParseConfig

func ParseConfig() (err error)

ParseConfig parsed default config file. now only support ini, next will support json.

func Run

func Run()

func SetLevel

func SetLevel(l int)

SetLogLevel sets the global log level used by the simple logger.

func SetLogFuncCall

func SetLogFuncCall(b bool)

func SetLogger

func SetLogger(adaptername string, config string) error

SetLogger sets a new logger.

func ShowAppHelp

func ShowAppHelp(c *Context)

func ShowCommandCompletions

func ShowCommandCompletions(ctx *Context, command string)

Prints the custom completions for a given command

func ShowCommandHelp

func ShowCommandHelp(c *Context, command string)

Prints help for the given command

func ShowCompletions

func ShowCompletions(c *Context)

Prints the lists of commands within a given context

func ShowSubcommandHelp

func ShowSubcommandHelp(c *Context)

Prints help for the given subcommand

func ShowVersion

func ShowVersion(c *Context)

Prints the version number of the App

func Trace

func Trace(v ...interface{})

Trace logs a message at trace level. Deprecated: compatibility alias for Warning(), Will be removed in 1.5.0.

func Warn deprecated

func Warn(v ...interface{})

Deprecated: compatibility alias for Warning(), Will be removed in 1.5.0.

func Warning

func Warning(v ...interface{})

Warning logs a message at warning level.

Types

type App

type App struct {
	Name string

	Usage string

	Version string

	Commands []Command

	Flags []Flag

	EnableBashCompletion bool

	HideHelp bool

	HideVersion bool

	BashComplete func(context *Context)

	Before func(context *Context) error

	After func(context *Context) error

	Action func(context *Context)

	CommandNotFound func(context *Context, command string)

	Compiled time.Time

	Authors []Author

	Author string

	Email string
	// Copyright (Default: CloudWise 2017)
	Copyright string

	Writer io.Writer
}

App is the main structure of a cli application. It is recomended that and app be created with the cli.NewApp() function

func NewApp

func NewApp() *App

Creates a new cli Application with some reasonable defaults for Name, Usage, Version and Action.

func (*App) Command

func (a *App) Command(name string) *Command

Returns the named command on App. Returns nil if the command does not exist

func (*App) Run

func (a *App) Run(arguments []string) (err error)

Entry point to the cli app. Parses the arguments slice and routes to the proper flag/args combination

func (*App) RunAndExitOnError

func (a *App) RunAndExitOnError()

Another entry point to the cli app, takes care of passing arguments and error handling

func (*App) RunAsSubcommand

func (a *App) RunAsSubcommand(ctx *Context) (err error)

Invokes the subcommand given the context, parses ctx.Args() to generate command-specific flags

type Args

type Args []string

func (Args) First

func (a Args) First() string

Returns the first argument, or else a blank string

func (Args) Get

func (a Args) Get(n int) string

Returns the nth argument, or else a blank string

func (Args) Present

func (a Args) Present() bool

Checks if there are any arguments present

func (Args) Swap

func (a Args) Swap(from, to int) error

Swaps arguments at the given indexes

func (Args) Tail

func (a Args) Tail() []string

Return the rest of the arguments (not the first one) or else an empty string slice

type Author

type Author struct {
	Name  string // The Authors name
	Email string // The Authors email
}

Author represents someone who has contributed to a cli project.

func (Author) String

func (a Author) String() string

String makes Author comply to the Stringer interface, to allow an easy print in the templating process

type BoolFlag

type BoolFlag struct {
	Name   string
	Usage  string
	EnvVar string
}

func (BoolFlag) Apply

func (f BoolFlag) Apply(set *flag.FlagSet)

func (BoolFlag) String

func (f BoolFlag) String() string

type BoolTFlag

type BoolTFlag struct {
	Name   string
	Usage  string
	EnvVar string
}

func (BoolTFlag) Apply

func (f BoolTFlag) Apply(set *flag.FlagSet)

func (BoolTFlag) String

func (f BoolTFlag) String() string

type Command

type Command struct {
	// The name of the command
	Name string
	// short name of the command. Typically one character (deprecated, use `Aliases`)
	ShortName string
	// A list of aliases for the command
	Aliases []string
	// A short description of the usage of this command
	Usage string
	// A longer explanation of how the command works
	Description string
	// The function to call when checking for bash command completions
	BashComplete func(context *Context)
	// An action to execute before any sub-subcommands are run, but after the context is ready
	// If a non-nil error is returned, no sub-subcommands are run
	Before func(context *Context) error
	// An action to execute after any subcommands are run, but after the subcommand has finished
	// It is run even if Action() panics
	After func(context *Context) error
	// The function to call when this command is invoked
	Action func(context *Context)
	// List of child commands
	Subcommands []Command
	// List of flags to parse
	Flags []Flag
	// Treat all flags as normal arguments if true
	SkipFlagParsing bool
	// Boolean to hide built-in help command
	HideHelp bool
}

Command is a subcommand for a cli.App.

func (Command) HasName

func (c Command) HasName(name string) bool

Returns true if Command.Name or Command.ShortName matches given name

func (Command) Names

func (c Command) Names() []string

func (Command) Run

func (c Command) Run(ctx *Context) error

Invokes the command given the context, parses ctx.Args() to generate command-specific flags

type Context

type Context struct {
	App     *App
	Command Command
	// contains filtered or unexported fields
}

Context is a type that is passed through to each Handler action in a cli application. Context can be used to retrieve context-specific Args and parsed command-line options.

func NewContext

func NewContext(app *App, set *flag.FlagSet, globalSet *flag.FlagSet) *Context

Creates a new context. For use in when invoking an App or Command action.

func (*Context) Args

func (c *Context) Args() Args

Returns the command line arguments associated with the context.

func (*Context) Bool

func (c *Context) Bool(name string) bool

Looks up the value of a local bool flag, returns false if no bool flag exists

func (*Context) BoolT

func (c *Context) BoolT(name string) bool

Looks up the value of a local boolT flag, returns false if no bool flag exists

func (*Context) Duration

func (c *Context) Duration(name string) time.Duration

Looks up the value of a local time.Duration flag, returns 0 if no time.Duration flag exists

func (*Context) FlagNames

func (c *Context) FlagNames() (names []string)

Returns a slice of flag names used in this context.

func (*Context) Float64

func (c *Context) Float64(name string) float64

Looks up the value of a local float64 flag, returns 0 if no float64 flag exists

func (*Context) Generic

func (c *Context) Generic(name string) interface{}

Looks up the value of a local generic flag, returns nil if no generic flag exists

func (*Context) GlobalBool

func (c *Context) GlobalBool(name string) bool

Looks up the value of a global bool flag, returns false if no bool flag exists

func (*Context) GlobalDuration

func (c *Context) GlobalDuration(name string) time.Duration

Looks up the value of a global time.Duration flag, returns 0 if no time.Duration flag exists

func (*Context) GlobalFlagNames

func (c *Context) GlobalFlagNames() (names []string)

Returns a slice of global flag names used by the app.

func (*Context) GlobalGeneric

func (c *Context) GlobalGeneric(name string) interface{}

Looks up the value of a global generic flag, returns nil if no generic flag exists

func (*Context) GlobalInt

func (c *Context) GlobalInt(name string) int

Looks up the value of a global int flag, returns 0 if no int flag exists

func (*Context) GlobalIntSlice

func (c *Context) GlobalIntSlice(name string) []int

Looks up the value of a global int slice flag, returns nil if no int slice flag exists

func (*Context) GlobalIsSet

func (c *Context) GlobalIsSet(name string) bool

Determines if the global flag was actually set

func (*Context) GlobalString

func (c *Context) GlobalString(name string) string

Looks up the value of a global string flag, returns "" if no string flag exists

func (*Context) GlobalStringSlice

func (c *Context) GlobalStringSlice(name string) []string

Looks up the value of a global string slice flag, returns nil if no string slice flag exists

func (*Context) Int

func (c *Context) Int(name string) int

Looks up the value of a local int flag, returns 0 if no int flag exists

func (*Context) IntSlice

func (c *Context) IntSlice(name string) []int

Looks up the value of a local int slice flag, returns nil if no int slice flag exists

func (*Context) IsSet

func (c *Context) IsSet(name string) bool

Determines if the flag was actually set

func (*Context) NumFlags

func (c *Context) NumFlags() int

Returns the number of flags set

func (*Context) String

func (c *Context) String(name string) string

Looks up the value of a local string flag, returns "" if no string flag exists

func (*Context) StringSlice

func (c *Context) StringSlice(name string) []string

Looks up the value of a local string slice flag, returns nil if no string slice flag exists

type DurationFlag

type DurationFlag struct {
	Name   string
	Value  time.Duration
	Usage  string
	EnvVar string
}

func (DurationFlag) Apply

func (f DurationFlag) Apply(set *flag.FlagSet)

func (DurationFlag) String

func (f DurationFlag) String() string

type Flag

type Flag interface {
	fmt.Stringer
	// Apply Flag settings to the given flag set
	Apply(*flag.FlagSet)
	// contains filtered or unexported methods
}

Flag is a common interface related to parsing flags in cli. For more advanced flag parsing techniques, it is recomended that this interface be implemented.

type Float64Flag

type Float64Flag struct {
	Name   string
	Value  float64
	Usage  string
	EnvVar string
}

func (Float64Flag) Apply

func (f Float64Flag) Apply(set *flag.FlagSet)

func (Float64Flag) String

func (f Float64Flag) String() string

type Generic

type Generic interface {
	Set(value string) error
	String() string
}

Generic is a generic parseable type identified by a specific flag

type GenericFlag

type GenericFlag struct {
	Name   string
	Value  Generic
	Usage  string
	EnvVar string
}

GenericFlag is the flag type for types implementing Generic

func (GenericFlag) Apply

func (f GenericFlag) Apply(set *flag.FlagSet)

Apply takes the flagset and calls Set on the generic flag with the value provided by the user for parsing by the flag

func (GenericFlag) String

func (f GenericFlag) String() string

String returns the string representation of the generic flag to display the help text to the user (uses the String() method of the generic flag to show the value)

type GoCrabAppConfig

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

func (*GoCrabAppConfig) Bool

func (b *GoCrabAppConfig) Bool(key string) (bool, error)

func (*GoCrabAppConfig) DIY

func (b *GoCrabAppConfig) DIY(key string) (interface{}, error)

func (*GoCrabAppConfig) DefaultBool

func (b *GoCrabAppConfig) DefaultBool(key string, defaultval bool) bool

func (*GoCrabAppConfig) DefaultFloat

func (b *GoCrabAppConfig) DefaultFloat(key string, defaultval float64) float64

func (*GoCrabAppConfig) DefaultInt

func (b *GoCrabAppConfig) DefaultInt(key string, defaultval int) int

func (*GoCrabAppConfig) DefaultInt64

func (b *GoCrabAppConfig) DefaultInt64(key string, defaultval int64) int64

func (*GoCrabAppConfig) DefaultString

func (b *GoCrabAppConfig) DefaultString(key string, defaultval string) string

func (*GoCrabAppConfig) DefaultStrings

func (b *GoCrabAppConfig) DefaultStrings(key string, defaultval []string) []string

func (*GoCrabAppConfig) Float

func (b *GoCrabAppConfig) Float(key string) (float64, error)

func (*GoCrabAppConfig) GetSection

func (b *GoCrabAppConfig) GetSection(section string) (map[string]string, error)

func (*GoCrabAppConfig) Int

func (b *GoCrabAppConfig) Int(key string) (int, error)

func (*GoCrabAppConfig) Int64

func (b *GoCrabAppConfig) Int64(key string) (int64, error)

func (*GoCrabAppConfig) SaveConfigFile

func (b *GoCrabAppConfig) SaveConfigFile(filename string) error

func (*GoCrabAppConfig) Set

func (b *GoCrabAppConfig) Set(key, val string) error

func (*GoCrabAppConfig) String

func (b *GoCrabAppConfig) String(key string) string

func (*GoCrabAppConfig) Strings

func (b *GoCrabAppConfig) Strings(key string) []string

type IntFlag

type IntFlag struct {
	Name   string
	Value  int
	Usage  string
	EnvVar string
}

func (IntFlag) Apply

func (f IntFlag) Apply(set *flag.FlagSet)

func (IntFlag) String

func (f IntFlag) String() string

type IntSlice

type IntSlice []int

func (*IntSlice) Set

func (f *IntSlice) Set(value string) error

func (*IntSlice) String

func (f *IntSlice) String() string

func (*IntSlice) Value

func (f *IntSlice) Value() []int

type IntSliceFlag

type IntSliceFlag struct {
	Name   string
	Value  *IntSlice
	Usage  string
	EnvVar string
}

func (IntSliceFlag) Apply

func (f IntSliceFlag) Apply(set *flag.FlagSet)

func (IntSliceFlag) String

func (f IntSliceFlag) String() string

type StringFlag

type StringFlag struct {
	Name   string
	Value  string
	Usage  string
	EnvVar string
}

func (StringFlag) Apply

func (f StringFlag) Apply(set *flag.FlagSet)

func (StringFlag) String

func (f StringFlag) String() string

type StringSlice

type StringSlice []string

func (*StringSlice) Set

func (f *StringSlice) Set(value string) error

func (*StringSlice) String

func (f *StringSlice) String() string

func (*StringSlice) Value

func (f *StringSlice) Value() []string

type StringSliceFlag

type StringSliceFlag struct {
	Name   string
	Value  *StringSlice
	Usage  string
	EnvVar string
}

func (StringSliceFlag) Apply

func (f StringSliceFlag) Apply(set *flag.FlagSet)

func (StringSliceFlag) String

func (f StringSliceFlag) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL