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

command

package

Go to main page

Versions in this module

v1

v1.0.0-rc.1

Jun 19, 2024

v1.0.0-rc.0

Jun 19, 2024

v0

v0.2.2

May 21, 2024

v0.2.1

Apr 20, 2024

v0.2.0

Apr 20, 2024

v0.1.4

Sep 26, 2023

v0.1.3

Sep 25, 2023

v0.1.2

Sep 24, 2023

v0.1.1

Sep 5, 2023

v0.1.0

Apr 4, 2023

Changes in this version

+ var Root = &Command

+ func RegisterValueSource(key string, completion CompletionFunc)

+ type Action func(cmd *Command) error

+ type Argument struct

+ Command *Command

+ Default any

+ Description string

+ Name string

+ Required bool

+ Values *ValueSource

+ Variadic bool

+ func (arg *Argument) EnvName() string

+ func (arg *Argument) IsKnown() bool

+ func (arg *Argument) Resolve(current string) (values []string, flag cobra.ShellCompDirective, err error)

+ func (arg *Argument) SetValue(value []string)

+ func (arg *Argument) ToDesc() string

+ func (arg *Argument) ToString() string

+ func (arg *Argument) ToValue() any

+ func (arg *Argument) Validate() error

+ func (arg *Argument) Validates() bool

+ type Arguments []*Argument

+ func (args *Arguments) AllKnown() map[string]any

+ func (args *Arguments) AllKnownStr() map[string]string

+ func (args *Arguments) AreValid() error

+ func (args *Arguments) CompletionFunction(cc *cobra.Command, provided []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ func (args *Arguments) Parse(supplied []string) error

+ type AutocompleteTemplate struct

+ Args map[string]string

+ Opts map[string]string

+ func (tpl *AutocompleteTemplate) Arg(name string) string

+ func (tpl *AutocompleteTemplate) Opt(name string) string

+ type Command struct

+ Action Action

+ Arguments Arguments

+ Cobra *cobra.Command

+ Description string

+ HelpFunc HelpFunc

+ Hidden bool

+ Meta any

+ Options Options

+ Path []string

+ Summary string

+ func (cmd *Command) AdditionalHelp(printLinks bool) *string

+ func (cmd *Command) FlagSet() *pflag.FlagSet

+ func (cmd *Command) FullName() string

+ func (cmd *Command) HasAdditionalHelp() bool

+ func (cmd *Command) HelpRenderer(globalOptions Options) func(cc *cobra.Command, args []string)

+ func (cmd *Command) IsRoot() bool

+ func (cmd *Command) Name() string

+ func (cmd *Command) ParseInput(cc *cobra.Command, args []string) error

+ func (cmd *Command) ResolveTemplate(templateString string, currentValue string) (string, error)

+ func (cmd *Command) Run(cc *cobra.Command, args []string) error

+ func (cmd *Command) SetBindings() *Command

+ func (cmd *Command) SetCobra(cc *cobra.Command)

+ func (cmd *Command) ShowHelp(globalOptions Options, args []string) ([]byte, error)

+ func (cmd *Command) Validate() (report map[string]int)

+ type CompletionFunc func(cmd *Command, currentValue string, config string) (values []string, flag cobra.ShellCompDirective, err error)

+ type HelpFunc func(printLinks bool) string

+ type Option struct

+ Command *Command

+ Default any

+ Description string

+ Repeated bool

+ ShortName string

+ Type ValueType

+ Values *ValueSource

+ func (opt *Option) CompletionFunction(cmd *cobra.Command, args []string, toComplete string) (values []string, flag cobra.ShellCompDirective)

+ func (opt *Option) IsKnown() bool

+ func (opt *Option) Resolve(currentValue string) (values []string, flag cobra.ShellCompDirective, err error)

+ func (opt *Option) ToString() string

+ func (opt *Option) ToValue() any

+ func (opt *Option) Validate(name string) error

+ func (opt *Option) Validates() bool

+ type Options map[string]*Option

+ func (opts *Options) AllKnown() map[string]any

+ func (opts *Options) AllKnownStr() map[string]string

+ func (opts *Options) AreValid() error

+ func (opts *Options) Parse(supplied *pflag.FlagSet)

+ type SourceCommand struct

+ Args string

+ Path []string

+ type ValueSource struct

+ Command *SourceCommand

+ Directories *string

+ Files *[]string

+ Func CompletionFunc

+ Script string

+ Static *[]string

+ SuggestRaw bool

+ Suggestion bool

+ Timeout int

+ func (vs *ValueSource) Resolve(currentValue string) (values []string, flag cobra.ShellCompDirective, err error)

+ func (vs *ValueSource) UnmarshalYAML(node *yaml.Node) error

+ func (vs *ValueSource) Validates() bool

+ type ValueType string

+ const ValueTypeBoolean

+ const ValueTypeDefault

+ const ValueTypeInt

+ const ValueTypeString