cobra

package module

Go to main page

Versions in this module

v1

v1.8.1

Jun 1, 2024

v1.8.0

Nov 2, 2023

Changes in this version

+ const CommandDisplayNameAnnotation

+ var EnableTraverseRunHooks = defaultTraverseRunHooks

type Command

+ func (c *Command) ErrPrefix() string

+ func (c *Command) GetFlagCompletionFunc(flagName string) (func(*Command, []string, string) ([]string, ShellCompDirective), bool)

+ func (c *Command) MarkFlagsOneRequired(flagNames ...string)

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

v1.7.0

Mar 22, 2023

Changes in this version

type ShellCompDirective

+ const ShellCompDirectiveKeepOrder

v1.6.1

Oct 24, 2022

v1.6.0

Oct 10, 2022

Changes in this version

+ const FlagSetByCobraAnnotation

+ var EnableCaseInsensitive = defaultCaseInsensitive

+ func OnFinalize(y ...func())

type Command

+ GroupID string

+ func (c *Command) AddGroup(groups ...*Group)

+ func (c *Command) AllChildCommandsHaveGroup() bool

+ func (c *Command) ContainsGroup(groupID string) bool

+ func (c *Command) Groups() []*Group

+ func (c *Command) InitDefaultCompletionCmd()

+ func (c *Command) SetCompletionCommandGroupID(groupID string)

+ func (c *Command) SetHelpCommandGroupID(groupID string)

+ func (c *Command) ValidateFlagGroups() error

+ func (c *Command) ValidateRequiredFlags() error

+ type Group struct

+ ID string

+ Title string

v1.5.0

Jun 21, 2022

Changes in this version

+ func AppendActiveHelp(compArray []string, activeHelpStr string) []string

+ func FixedCompletions(choices []string, directive ShellCompDirective) ...

+ func GetActiveHelpConfig(cmd *Command) string

type Command

+ func (c *Command) MarkFlagsMutuallyExclusive(flagNames ...string)

+ func (c *Command) MarkFlagsRequiredTogether(flagNames ...string)

+ func (c *Command) SetContext(ctx context.Context)

v1.4.0

Mar 10, 2022

v1.3.0

Dec 14, 2021

Changes in this version

type CompletionOptions

+ HiddenDefaultCmd bool

type PositionalArgs

+ func MatchAll(pargs ...PositionalArgs) PositionalArgs

v1.2.1

Jul 2, 2021

v1.2.0

Jul 1, 2021

Changes in this version

type Command

+ CompletionOptions CompletionOptions

+ func (c *Command) ExecuteContextC(ctx context.Context) (*Command, error)

+ func (c *Command) GenBashCompletionFileV2(filename string, includeDesc bool) error

+ func (c *Command) GenBashCompletionV2(w io.Writer, includeDesc bool) error

+ type CompletionOptions struct

+ DisableDefaultCmd bool

+ DisableDescriptions bool

+ DisableNoDescFlag bool

type ShellCompDirective

+ func NoFileCompletions(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)

v1.1.3

Feb 10, 2021

v1.1.2

Feb 10, 2021

Changes in this version

+ func CheckErr(msg interface{})

+ func WriteStringAndCheck(b io.StringWriter, s string)

type Command

+ func (c *Command) GenPowerShellCompletionFileWithDesc(filename string) error

+ func (c *Command) GenPowerShellCompletionWithDesc(w io.Writer) error

v1.1.1

Oct 18, 2020

v1.1.0

Oct 14, 2020

Changes in this version

type Command

+ func (c *Command) GenZshCompletionFileNoDesc(filename string) error

+ func (c *Command) GenZshCompletionNoDesc(w io.Writer) error

type ShellCompDirective

+ const ShellCompDirectiveFilterDirs

+ const ShellCompDirectiveFilterFileExt

v1.0.0

Apr 10, 2020

Changes in this version

+ const ShellCompNoDescRequestCmd

+ const ShellCompRequestCmd

+ func CompDebug(msg string, printToStdErr bool)

+ func CompDebugln(msg string, printToStdErr bool)

+ func CompError(msg string)

+ func CompErrorln(msg string)

type Command

+ ValidArgsFunction func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)

+ func (c *Command) GenFishCompletion(w io.Writer, includeDesc bool) error

+ func (c *Command) GenFishCompletionFile(filename string, includeDesc bool) error

+ func (c *Command) RegisterFlagCompletionFunc(flagName string, ...) error

+ type ShellCompDirective int

+ const ShellCompDirectiveDefault

+ const ShellCompDirectiveError

+ const ShellCompDirectiveNoFileComp

+ const ShellCompDirectiveNoSpace

v0

v0.0.7

Mar 27, 2020

v0.0.6

Feb 20, 2020

Changes in this version

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

type Command

+ func (c *Command) Context() context.Context

+ func (c *Command) ExecuteContext(ctx context.Context) error

v0.0.5

Jun 7, 2019

Changes in this version

+ func MarkFlagDirname(flags *pflag.FlagSet, name string) error

type Command

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

+ func (c *Command) GenPowerShellCompletion(w io.Writer) error

+ func (c *Command) GenPowerShellCompletionFile(filename string) error

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

+ func (c *Command) MarkFlagDirname(name string) error

+ func (c *Command) MarkPersistentFlagDirname(name string) error

+ func (c *Command) MarkZshCompPositionalArgumentFile(argPosition int, patterns ...string) error

+ func (c *Command) MarkZshCompPositionalArgumentWords(argPosition int, words ...string) error

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

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

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

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

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

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

v0.0.4

Mar 21, 2019

Changes in this version

+ var MousetrapDisplayDuration time.Duration = 5 * time.Second

type PositionalArgs

+ func ExactValidArgs(n int) PositionalArgs

v0.0.3

Apr 27, 2018

Changes in this version

type Command

+ FParseErrWhitelist FParseErrWhitelist

+ type FParseErrWhitelist flag.ParseErrorsWhitelist

v0.0.2

Mar 21, 2018

Changes in this version

type Command

+ DisableFlagsInUseLine bool

+ Version string

+ func (c *Command) CalledAs() string

+ func (c *Command) InitDefaultVersionFlag()

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

+ func (c *Command) VersionTemplate() string

v0.0.1

Oct 12, 2017

Changes in this version

+ const BashCompCustom

+ const BashCompFilenameExt

+ const BashCompOneRequiredFlag

+ const BashCompSubdirsInDir

+ var EnableCommandSorting = true

+ var EnablePrefixMatching = false

+ var MousetrapHelpText string = ...

+ func AddTemplateFunc(name string, tmplFunc interface{})

+ func AddTemplateFuncs(tmplFuncs template.FuncMap)

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

+ func Eq(a interface{}, b interface{}) bool

+ func Gt(a interface{}, b interface{}) bool

+ func MarkFlagCustom(flags *pflag.FlagSet, name string, f string) error

+ func MarkFlagFilename(flags *pflag.FlagSet, name string, extensions ...string) error

+ func MarkFlagRequired(flags *pflag.FlagSet, name string) error

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

+ func OnInitialize(y ...func())

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

+ type Command struct

+ Aliases []string

+ Annotations map[string]string

+ ArgAliases []string

+ Args PositionalArgs

+ BashCompletionFunction string

+ Deprecated string

+ DisableAutoGenTag bool

+ DisableFlagParsing bool

+ DisableSuggestions bool

+ Example string

+ Hidden bool

+ Long string

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

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

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

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

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

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

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

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

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

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

+ Short string

+ SilenceErrors bool

+ SilenceUsage bool

+ SuggestFor []string

+ SuggestionsMinimumDistance int

+ TraverseChildren bool

+ Use string

+ ValidArgs []string

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

+ func (c *Command) ArgsLenAtDash() int

+ func (c *Command) CommandPath() string

+ func (c *Command) CommandPathPadding() int

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

+ func (c *Command) DebugFlags()

+ func (c *Command) Execute() error

+ func (c *Command) ExecuteC() (cmd *Command, err error)

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

+ func (c *Command) Flag(name string) (flag *flag.Flag)

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

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

+ func (c *Command) GenBashCompletion(w io.Writer) error

+ func (c *Command) GenBashCompletionFile(filename string) error

+ func (c *Command) GenZshCompletion(w io.Writer) error

+ func (c *Command) GenZshCompletionFile(filename string) error

+ func (c *Command) GlobalNormalizationFunc() func(f *flag.FlagSet, name string) flag.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) InheritedFlags() *flag.FlagSet

+ func (c *Command) InitDefaultHelpCmd()

+ func (c *Command) InitDefaultHelpFlag()

+ func (c *Command) IsAdditionalHelpTopicCommand() bool

+ func (c *Command) IsAvailableCommand() bool

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

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

+ func (c *Command) MarkFlagCustom(name string, f string) error

+ func (c *Command) MarkFlagFilename(name string, extensions ...string) error

+ func (c *Command) MarkFlagRequired(name string) error

+ func (c *Command) MarkPersistentFlagFilename(name string, extensions ...string) error

+ func (c *Command) MarkPersistentFlagRequired(name string) error

+ func (c *Command) Name() string

+ func (c *Command) NameAndAliases() string

+ func (c *Command) NamePadding() int

+ func (c *Command) NonInheritedFlags() *flag.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() *flag.FlagSet

+ func (c *Command) Print(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) Runnable() bool

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

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

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

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

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

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

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

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

+ func (c *Command) SetUsageTemplate(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) VisitParents(fn func(*Command))

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

+ func ExactArgs(n int) PositionalArgs

+ func MaximumNArgs(n int) PositionalArgs

+ func MinimumNArgs(n int) PositionalArgs

+ func RangeArgs(min int, max int) PositionalArgs

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