Interface CompletionOptions

CompletionOptions are the options to control shell completion

Hierarchy

  • CompletionOptions

Methods

setDefaultShellCompDirective

Properties

defaultShellCompDirective? disableDefaultCmd disableDescriptions disableNoDescFlag hiddenDefaultCmd

Methods

setDefaultShellCompDirective

Properties

Optional defaultShellCompDirective

defaultShellCompDirective?: ShellCompDirective

DefaultShellCompDirective sets the ShellCompDirective that is returned if no special directive can be determined

disableDefaultCmd

disableDefaultCmd: boolean

DisableDefaultCmd prevents Cobra from creating a default 'completion' command

disableDescriptions

disableDescriptions: boolean

DisableDescriptions turns off all completion descriptions for shells that support them

disableNoDescFlag

disableNoDescFlag: boolean

DisableNoDescFlag prevents Cobra from creating the '--no-descriptions' flag for shells that support completion descriptions

hiddenDefaultCmd

hiddenDefaultCmd: boolean

HiddenDefaultCmd makes the default 'completion' command hidden

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc