Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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
- API
  
  Reference documentation for the pkg.go.dev API
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

completion

package

Go to main page

Versions in this module

v0

v0.1.20

Aug 5, 2026

v0.1.19

Jan 9, 2026

v0.1.18

Dec 11, 2025

v0.1.17

Dec 10, 2025

v0.1.16

Nov 25, 2025

v0.1.15

Nov 21, 2025

v0.1.14

Nov 20, 2025

Changes in this version

+ func NewCompletionCommand(root *cli.CLI) *cli.CLI

+ type CommandCompletion struct

+ func NewCommandCompletion(cli *cli.CLI) *CommandCompletion

+ func (c *CommandCompletion) Complete(args []string, toComplete string) []string

+ func (c *CommandCompletion) CompleteWithDesc(args []string, toComplete string) []CompletionItem

+ func (c *CommandCompletion) GetType() CompletionType

+ type Completion interface

+ Complete func(args []string, toComplete string) []string

+ CompleteWithDesc func(args []string, toComplete string) []CompletionItem

+ GetType func() CompletionType

+ type CompletionFunc any

+ type CompletionItem struct

+ Description string

+ Value string

+ type CompletionManager struct

+ func New(root *cli.CLI) *CompletionManager

+ func NewCompletionManager(cli *cli.CLI) *CompletionManager

+ func (cm *CompletionManager) Complete(args []string, toComplete string) []string

+ func (cm *CompletionManager) CompleteWithDesc(args []string, toComplete string) []CompletionItem

+ func (cm *CompletionManager) GenerateBashCompletion(w io.Writer, cmdName string) error

+ func (cm *CompletionManager) GenerateCompletion(shell string, cname ...string) error

+ func (cm *CompletionManager) GenerateFishCompletion(w io.Writer, cmdName string) error

+ func (cm *CompletionManager) GenerateZshCompletion(w io.Writer, cmdName string) error

+ func (cm *CompletionManager) HandleCompletion(args []string) error

+ func (cm *CompletionManager) RegisterCompletion(cli *cli.CLI, flagName string, completion Completion)

+ func (cm *CompletionManager) RegisterCustomCompletion(cli *cli.CLI, flagName string, fn CompletionFunc)

+ func (cm *CompletionManager) RegisterCustomCompletionPrefixMatches(cli *cli.CLI, flagName string, completionItems any)

+ func (cm *CompletionManager) RegisterDirectoryCompletion(cli *cli.CLI, flagName string)

+ func (cm *CompletionManager) RegisterFileCompletion(cli *cli.CLI, flagName string, extensions ...string)

+ type CompletionType int

+ const CompletionTypeCommand

+ const CompletionTypeCustom

+ const CompletionTypeDirectory

+ const CompletionTypeFile

+ const CompletionTypeFlag

+ type CustomCompletion struct

+ func NewCustomCompletion(fn CompletionFunc) *CustomCompletion

+ func (c *CustomCompletion) Complete(args []string, toComplete string) []string

+ func (c *CustomCompletion) CompleteWithDesc(args []string, toComplete string) []CompletionItem

+ func (c *CustomCompletion) GetType() CompletionType

+ type FileCompletion struct

+ func NewDirectoryCompletion() *FileCompletion

+ func NewFileCompletion(extensions ...string) *FileCompletion

+ func (f *FileCompletion) Complete(args []string, toComplete string) []string

+ func (f *FileCompletion) CompleteWithDesc(args []string, toComplete string) []CompletionItem

+ func (f *FileCompletion) GetType() CompletionType

+ type FlagCompletion struct

+ func NewFlagCompletion(flagSet *cli.FlagSet) *FlagCompletion

+ func (f *FlagCompletion) Complete(args []string, toComplete string) []string

+ func (f *FlagCompletion) CompleteWithDesc(args []string, toComplete string) []CompletionItem

+ func (f *FlagCompletion) GetType() CompletionType