completion

Documentation

Index

• Constants
• func BashInstall(path string) error
• func ConfirmInstallationPath(path string, shell string) bool
• func FishInstall(path string) error
• func GetShellConfigPath(shellType string) (string, error)
• func PermissionToInstallPrompt(shell string) bool
• func PrintInstallationInstructionsToStdout(cmd *cobra.Command, shellChoice string)
• func ZshInstall(path string) error

Constants

const BashHelp = `` /* 231-byte string literal not displayed */

BashHelp prints for users who elect to install their bash completion scripts manually

const FishHelp = `` /* 158-byte string literal not displayed */

FishHelp prints to users who elect to manually install fish

const ZshHelp = `` /* 360-byte string literal not displayed */

ZshHelp is printed for users who elect to manually install the completion scripts

Functions

func BashInstall

func BashInstall(path string) error

BashInstall adds the bash completion scripts to the user's host machine

func ConfirmInstallationPath

func ConfirmInstallationPath(path string, shell string) bool

ConfirmInstallationPath verifies whether the given installation path is correct

func FishInstall

func FishInstall(path string) error

FishInstall handles installing the fish completion scripts on the user's host machine

func GetShellConfigPath

func GetShellConfigPath(shellType string) (string, error)

GetShellConfigPath is

func PermissionToInstallPrompt

func PermissionToInstallPrompt(shell string) bool

PermissionToInstallPrompt prompts the user for whether pls can install the completion scripts on their host machine

func PrintInstallationInstructionsToStdout

func PrintInstallationInstructionsToStdout(cmd *cobra.Command, shellChoice string)

PrintInstallationInstructionsToStdout outputs installation instructions for compatible shells shells

func ZshInstall

func ZshInstall(path string) error

ZshInstall handles installing zsh completion scripts to the user's host machine