README
¶
package cliz
Usage
import (
"log"
cliz "github.com/kunitsucom/util.go/exp/cli"
)
func main() {
cmd := &cliz.Command{
Name: "my-cli",
Description: "My awesome CLI tool",
Usage: "my-cli [options] <subcommand> [arguments...]",
Options: []Option{
&BoolOption{
Name: "version",
Short: "v",
Description: "show version",
Default: Default(false),
},
},
SubCommands: []*Command{
{
Name: "sub-cmd",
Description: `My awesome CLI tool's sub command.`,
},
},
}
called, remaining, err := cmd.Parse(os.Args[1:])
if err != nil {
if errors.Is(err, cliz.ErrHelp) {
return
}
log.Fatalf("failed to parse command line arguments: %+v", err)
}
// ...
}
Documentation
¶
Index ¶
- Constants
- Variables
- func Default[T interface{}](v T) *T
- func IsHelp(err error) bool
- type BoolOption
- type Command
- func (cmd *Command) GetBoolOption(name string) (bool, error)
- func (cmd *Command) GetFloat64Option(name string) (float64, error)
- func (cmd *Command) GetIntOption(name string) (int, error)
- func (cmd *Command) GetName() string
- func (cmd *Command) GetStringOption(name string) (string, error)
- func (cmd *Command) Next() *Command
- func (cmd *Command) Parse(args []string) (called []string, remaining []string, err error)
- func (cmd *Command) ShowUsage()
- type Float64Option
- type IntOption
- type Option
- type StringOption
Constants ¶
View Source
const ( // UTIL_GO_CLI_TRACE is the environment variable name for trace log. UTIL_GO_CLI_TRACE = "UTIL_GO_CLI_TRACE" // UTIL_GO_CLI_DEBUG is the environment variable name for debug log. UTIL_GO_CLI_DEBUG = "UTIL_GO_CLI_DEBUG" )
View Source
const HelpOptionName = "help"
HelpOptionName is the option name for help.
Variables ¶
View Source
var ( // Stdout is the writer to be used for standard output. Stdout io.Writer = os.Stdout // Stderr is the writer to be used for standard error. Stderr io.Writer = os.Stderr )
View Source
var ( // TraceLog is the logger to be used for trace log. TraceLog = newLogger(Stderr, UTIL_GO_CLI_TRACE, "TRACE: ") // DebugLog is the logger to be used for debug log. DebugLog = newLogger(Stderr, UTIL_GO_CLI_DEBUG, "DEBUG: ") )
View Source
var ( ErrHelp = errors.New("help requested") ErrMissingOptionValue = errors.New("missing option value") ErrOptionRequired = errors.New("option required") ErrNoOption = errors.New("no option") ErrUnknownOption = errors.New("unknown option") ErrInvalidOptionType = errors.New("invalid option type") ErrUnexpectedError = errors.New("unexpected error") ErrDuplicateOptionName = errors.New("duplicate option name") ErrDuplicateSubCommand = errors.New("duplicate sub command") ErrMultipleOptionsDefaultValue = errors.New("multiple options with the same name, only one option can have a default value") )
Functions ¶
Types ¶
type BoolOption ¶
type BoolOption struct {
// Name is the name of the option.
Name string
// Short is the short name of the option.
Short string
// Environment is the environment variable name of the option.
Environment string
// Description is the description of the option.
Description string
// Default is the default value of the option.
Default *bool
// contains filtered or unexported fields
}
BoolOption is the option for bool value.
func (*BoolOption) GetDescription ¶
func (o *BoolOption) GetDescription() string
func (*BoolOption) GetEnvironment ¶
func (o *BoolOption) GetEnvironment() string
func (*BoolOption) GetName ¶
func (o *BoolOption) GetName() string
func (*BoolOption) GetShort ¶
func (o *BoolOption) GetShort() string
func (*BoolOption) HasDefault ¶
func (o *BoolOption) HasDefault() bool
func (*BoolOption) HasValue ¶ added in v0.0.59
func (o *BoolOption) HasValue() bool
type Command ¶
type Command struct {
// Name is the name of the command.
Name string
// Description is the description of the command.
Description string
// SubCommands is the subcommands of the command.
SubCommands []*Command
// Options is the options of the command.
Options []Option
// Usage is the usage of the command.
//
// If you want to use the default usage, remain empty.
// Otherwise, set the custom usage.
Usage string
// UsageFunc is custom usage function.
//
// If you want to use the default usage function, remain nil.
// Otherwise, set the custom usage function.
UsageFunc func(c *Command)
// contains filtered or unexported fields
}
Command is a structure for building command lines. Please fill in each field for the structure you are facing.
func (*Command) GetFloat64Option ¶
func (*Command) Parse ¶
Parse parses the arguments as commands and sub commands and options.
If the "--help" option is specified, it will be displayed and ErrHelp will be returned.
If the option is not specified, the default value will be used.
If the environment variable is specified, it will be used as the value of the option.
type Float64Option ¶ added in v0.0.59
type Float64Option struct {
// Name is the name of the option.
Name string
// Short is the short name of the option.
Short string
// Environment is the environment variable name of the option.
Environment string
// Description is the description of the option.
Description string
// Default is the default value of the option.
Default *float64
// contains filtered or unexported fields
}
Float64Option is the option for float value.
func (*Float64Option) GetDescription ¶ added in v0.0.59
func (o *Float64Option) GetDescription() string
func (*Float64Option) GetEnvironment ¶ added in v0.0.59
func (o *Float64Option) GetEnvironment() string
func (*Float64Option) GetName ¶ added in v0.0.59
func (o *Float64Option) GetName() string
func (*Float64Option) GetShort ¶ added in v0.0.59
func (o *Float64Option) GetShort() string
func (*Float64Option) HasDefault ¶ added in v0.0.59
func (o *Float64Option) HasDefault() bool
func (*Float64Option) HasValue ¶ added in v0.0.59
func (o *Float64Option) HasValue() bool
type IntOption ¶
type IntOption struct {
// Name is the name of the option.
Name string
// Short is the short name of the option.
Short string
// Environment is the environment variable name of the option.
Environment string
// Description is the description of the option.
Description string
// Default is the default value of the option.
Default *int
// contains filtered or unexported fields
}
IntOption is the option for int value.
func (*IntOption) GetDescription ¶
func (*IntOption) GetEnvironment ¶
func (*IntOption) HasDefault ¶
type Option ¶
type Option interface {
// GetName returns the name of the option.
GetName() string
// GetShort returns the short name of the option.
GetShort() string
// GetEnvironment returns the environment variable name of the option.
GetEnvironment() string
// GetDescription returns the description of the option.
GetDescription() string
// HasDefault returns whether the option has a default value.
HasDefault() bool
// HasValue returns whether the option has a value.
HasValue() bool
// contains filtered or unexported methods
}
Option is the interface for the option.
type StringOption ¶
type StringOption struct {
// Name is the name of the option.
Name string
// Short is the short name of the option.
Short string
// Environment is the environment variable name of the option.
Environment string
// Description is the description of the option.
Description string
// Default is the default value of the option.
Default *string
// contains filtered or unexported fields
}
StringOption is the option for string value.
func (*StringOption) GetDescription ¶
func (o *StringOption) GetDescription() string
func (*StringOption) GetEnvironment ¶
func (o *StringOption) GetEnvironment() string
func (*StringOption) GetName ¶
func (o *StringOption) GetName() string
func (*StringOption) GetShort ¶
func (o *StringOption) GetShort() string
func (*StringOption) HasDefault ¶
func (o *StringOption) HasDefault() bool
func (*StringOption) HasValue ¶ added in v0.0.59
func (o *StringOption) HasValue() bool
Source Files
Click to show internal directories.
Click to hide internal directories.