Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cli

package

Go to main page

Versions in this module

v1

v1.0.5

Dec 3, 2024

v1.0.4

Dec 9, 2022

Changes in this version

+ var CompOneRequiredFlag = "completion_one_required_flag"

+ var DefaultEol = "\r\n"

+ var EnableCommandSorting = true

+ var EnablePrefixMatching = false

+ var ErrSubCommandRequired = errors.New("subcommand is required")

+ func OnlyValidArgs(cmd *Command, args []string) error

+ type Command struct

+ Activate bool

+ Aliases []string

+ Annotations map[string]string

+ ArgAliases []string

+ Args PositionalArgs

+ Background bool

+ CommonCommands bool

+ Deprecated string

+ DisableAutoGenTag bool

+ DisableFlagParsing bool

+ DisableFlagsInUseLine bool

+ DisableSuggestions bool

+ Example string

+ FParseErrWhitelist FParseErrWhitelist

+ Hidden bool

+ Long string

+ PaintEvent func(cmd *Command, pid int, ctx interface{}, surface interfaces.ISurface)

+ PersistentPostRun func(cmd *Command, pid int, args []string)

+ PersistentPostRunE func(cmd *Command, pid int, args []string) error

+ PersistentPreRun func(cmd *Command, pid int, args []string)

+ PersistentPreRunE func(cmd *Command, pid int, args []string) error

+ Pid int

+ PostRun func(cmd *Command, pid int, args []string)

+ PostRunE func(cmd *Command, pid int, args []string) error

+ PreRun func(cmd *Command, pid int, args []string)

+ PreRunE func(cmd *Command, pid int, args []string) error

+ ReadEvent func(cmd *Command, pid int, ctx interface{}, code int, key rune)

+ Run func(cmd *Command, pid int, args []string)

+ RunE func(cmd *Command, pid int, args []string) error

+ Short string

+ SilenceErrors bool

+ SilenceUsage bool

+ SuggestFor []string

+ SuggestionsMinimumDistance int

+ TimerEvent func(cmd *Command, pid int, tid int, ctx interface{}, interval int)

+ TraverseChildren bool

+ Use string

+ ValidArgs []string

+ Version string

+ func NewCommand() *Command

+ func (c *Command) AddCommand(cmds ...*Command) error

+ func (c *Command) ArgsLenAtDash() int

+ func (c *Command) CalledAs() string

+ func (c *Command) Childs() []*Command

+ func (c *Command) CommandPath() string

+ func (c *Command) CommandPathPadding() int

+ func (c *Command) Commands() []*Command

+ func (c *Command) DebugFlags()

+ func (c *Command) ErrOrStderr() io.Writer

+ func (c *Command) Execute(cmd *Command, flags []string, pid int) error

+ func (c *Command) Find(args []string) (*Command, []string, error)

+ func (c *Command) Flag(name string) (xFlag *mflag.Flag)

+ func (c *Command) FlagErrorFunc() (f func(*Command, error) error)

+ func (c *Command) Flags() *mflag.FlagSet

+ func (c *Command) GetFlagErrorFunc() func(*Command, error) error

+ func (c *Command) GetGlobalNormalizationFunc() func(f *mflag.FlagSet, name string) mflag.NormalizedName

+ func (c *Command) GetHelpCommand() *Command

+ func (c *Command) GetHelpFunc() func(*Command, []string)

+ func (c *Command) GetHelpTemplate() string

+ func (c *Command) GetRootContext() interfaces.IContext

+ func (c *Command) GetUsageFunc() func(*Command) error

+ func (c *Command) GetUsageTemplate() string

+ func (c *Command) GetVersionTemplate() string

+ func (c *Command) GlobalNormalizationFunc() func(f *mflag.FlagSet, name string) mflag.NormalizedName

+ func (c *Command) HasAlias(s string) bool

+ func (c *Command) HasAvailableFlags() bool

+ func (c *Command) HasAvailableInheritedFlags() bool

+ func (c *Command) HasAvailableLocalFlags() bool

+ func (c *Command) HasAvailablePersistentFlags() bool

+ func (c *Command) HasAvailableSubCommands() bool

+ func (c *Command) HasExample() bool

+ func (c *Command) HasFlags() bool

+ func (c *Command) HasHelpSubCommands() bool

+ func (c *Command) HasInheritedFlags() bool

+ func (c *Command) HasLocalFlags() bool

+ func (c *Command) HasParent() bool

+ func (c *Command) HasPersistentFlags() bool

+ func (c *Command) HasSubCommands() bool

+ func (c *Command) Help() error

+ func (c *Command) HelpFunc() func(*Command, []string)

+ func (c *Command) HelpTemplate() string

+ func (c *Command) InOrStdin() io.Reader

+ func (c *Command) InheritedFlags() *mflag.FlagSet

+ func (c *Command) InitDefaultHelpCmd()

+ func (c *Command) InitDefaultHelpFlag()

+ func (c *Command) InitDefaultVersionFlag()

+ func (c *Command) IsAdditionalHelpTopicCommand() bool

+ func (c *Command) IsAvailableCommand() bool

+ func (c *Command) LocalFlags() *mflag.FlagSet

+ func (c *Command) LocalNonPersistentFlags() *mflag.FlagSet

+ func (c *Command) Name() string

+ func (c *Command) NameAndAliases() string

+ func (c *Command) NamePadding() int

+ func (c *Command) NonInheritedFlags() *mflag.FlagSet

+ func (c *Command) OutOrStderr() io.Writer

+ func (c *Command) OutOrStdout() io.Writer

+ func (c *Command) Parent() *Command

+ func (c *Command) ParseFlags(args []string) error

+ func (c *Command) PersistentFlags() *mflag.FlagSet

+ func (c *Command) Prepare() (*Command, []string, error)

+ func (c *Command) Print(i ...interface{})

+ func (c *Command) PrintErr(i ...interface{})

+ func (c *Command) PrintErrf(format string, i ...interface{})

+ func (c *Command) PrintErrln(i ...interface{})

+ func (c *Command) Printf(format string, i ...interface{})

+ func (c *Command) Println(i ...interface{})

+ func (c *Command) RemoveCommand(cmds ...*Command)

+ func (c *Command) ResetCommands()

+ func (c *Command) ResetFlags()

+ func (c *Command) Root() *Command

+ func (c *Command) RootParent() *Command

+ func (c *Command) Runnable() bool

+ func (c *Command) SetArgs(a []string)

+ func (c *Command) SetErr(newErr io.Writer)

+ func (c *Command) SetFlagErrorFunc(f func(*Command, error) error)

+ func (c *Command) SetGlobalNormalizationFunc(n func(f *mflag.FlagSet, name string) mflag.NormalizedName)

+ func (c *Command) SetHelpCommand(cmd *Command)

+ func (c *Command) SetHelpFunc(f func(*Command, []string))

+ func (c *Command) SetHelpTemplate(s string)

+ func (c *Command) SetIn(newIn io.Reader)

+ func (c *Command) SetOut(newOut io.Writer)

+ func (c *Command) SetOutput(output io.Writer)

+ func (c *Command) SetRootContext(ctx interfaces.IContext)

+ func (c *Command) SetUsageFunc(f func(*Command) error)

+ func (c *Command) SetUsageTemplate(s string)

+ func (c *Command) SetVersionTemplate(s string)

+ func (c *Command) SuggestionsFor(typedName string) []string

+ func (c *Command) Traverse(args []string) (*Command, []string, error)

+ func (c *Command) Usage() error

+ func (c *Command) UsageFunc() (f func(*Command) error)

+ func (c *Command) UsagePadding() int

+ func (c *Command) UsageString() string

+ func (c *Command) UsageTemplate() string

+ func (c *Command) UseLine() string

+ func (c *Command) ValidateArgs(args []string) error

+ func (c *Command) VersionTemplate() string

+ func (c *Command) VisitParents(fn func(*Command))

+ func (c *Command) Write(data []byte)

+ func (c *Command) WriteLn(data []byte)

+ type FParseErrWhitelist mflag.ParseErrorsWhitelist

+ type PositionalArgs func(cmd *Command, args []string) error

+ func ExactArgs(n int) PositionalArgs

v1.0.3

Dec 9, 2022

v1.0.2

Dec 9, 2022

v1.0.1

Dec 24, 2021

v1.0.0

Dec 24, 2021