completion

Thecompletion package extendsserpent to allow applications to generate rich auto-completions.

Protocol

The completion scripts call out to the serpent command to generatecompletions. The convention is to pass the exact args and flags (orcmdline) of the in-progress command with aCOMPLETION_MODE=1 environment variable. That environment variable lets the command know to generate completions instead of running the command.By default, completions will be generated based on available flags and subcommands. Additional completions can be added by supplying aCompletionHandlerFunc on an Option or Command.

Constants¶

const (ShellBashstring = "bash"ShellFishstring = "fish"ShellZshstring = "zsh"ShellPowershellstring = "powershell")

Variables¶

Functions¶

func FileHandler(filter func(infoos.FileInfo)bool)serpent.CompletionHandlerFunc

func InstallShellCompletion(shellShell)error

func ShellOptions(choice *string) *serpent.Enum

Types¶

type Shell interface {Name()stringInstallPath() (string,error)WriteCompletion(io.Writer)errorProgramName()string}

func Bash(goosstring, programNamestring)Shell

func DetectUserShell(programNamestring) (Shell,error)

func Fish(goosstring, programNamestring)Shell

func Powershell(goosstring, programNamestring)Shell

func ShellByName(shell, programNamestring) (Shell,error)

func Zsh(goosstring, programNamestring)Shell