cli

Documentation

Index

• func DefaultUnmarshalProps() argo.UnmarshalProps
• func LFlag(long, desc string) argo.FlagBuilder
• func NewArg() argo.ArgumentBuilder
• func NewCommand() argo.CommandBuilder
• func NewFlag() argo.FlagBuilder
• func NewFlagGroup() argo.FlagGroupBuilder
• func Provider() argo.Provider
• func SFlag(short byte, desc string) argo.FlagBuilder
• func SetProvider(pro argo.Provider)
• func SlFlag(short byte, long, desc string) argo.FlagBuilder
• func Unmarshal(raw string, ptr interface{}, props argo.UnmarshalProps) (err error)
• func UnmarshalDefault(raw string, ptr interface{}) (err error)

Functions

func DefaultUnmarshalProps

func DefaultUnmarshalProps() argo.UnmarshalProps

DefaultUnmarshalProps returns a defaulted unmarshaling configuration.

func LFlag

func LFlag(long, desc string) argo.FlagBuilder

LFlag is a shorthand for creating a new FlagBuilder then setting the long flag and description.

Same as calling `NewFlag().Long(long).Description(desc)`

func NewArg

func NewArg() argo.ArgumentBuilder

NewArg returns a new instance of an ArgumentBuilder from the current provider.

Same as calling `Provider().NewArg()`

func NewCommand

func NewCommand() argo.CommandBuilder

NewCommand returns a new instance of a CommandBuilder from the current provider.

Same as calling `Provider().NewCommand()`

func NewFlag

func NewFlag() argo.FlagBuilder

NewFlag returns a new instance of a FlagBuilder from the current provider.

Same as calling `Provider().NewFlag()`

func NewFlagGroup

func NewFlagGroup() argo.FlagGroupBuilder

NewFlagGroup returns a new instance of a FlagGroupBuilder from the current provider

Same as calling `Provider().NewFlagGroup()`

func Provider

func Provider() argo.Provider

Provider returns an instance of the default Provider implementation.

This method is provided to allow the use of custom CLI element implementations.

func SFlag

func SFlag(short byte, desc string) argo.FlagBuilder

SFlag is a shorthand for creating a new FlagBuilder then setting the short flag and description.

Same as calling `NewFlag().Short(short).Description(desc)`

func SetProvider

func SetProvider(pro argo.Provider)

SetProvider allows the override of the provider type.

Intended to allow completely changing the behavior of of the way CLI elements are constructed.

func SlFlag

func SlFlag(short byte, long, desc string) argo.FlagBuilder

SlFlag is a shorthand for creating a new FlagBuilder then setting the short flag, long flag, and description.

Same as calling `NewFlag().Short(short).Long(long).Description(desc)`

func Unmarshal

func Unmarshal(raw string, ptr interface{}, props argo.UnmarshalProps) (err error)

Unmarshal attempts to unmarshal the given string into the given pointer using the provided unmarshaling configuration.

func UnmarshalDefault

func UnmarshalDefault(raw string, ptr interface{}) (err error)

UnmarshalDefault attempts to unmarshal the given string into the given pointer using the default unmarshaling configuration.