environment

Documentation

Index

• func GetExecutedVersion(installPath string, executionPath string, ...) (string, bool, error)
• func Realpath(path string) (string, error)
• type Paths
  • func MustGetKrewPaths() Paths
  • func (p Paths) BasePath() string
  • func (p Paths) BinPath() string
  • func (p Paths) DownloadPath() string
  • func (p Paths) IndexPath() string
  • func (p Paths) InstallPath() string
  • func (p Paths) PluginInstallPath(plugin string) string
  • func (p Paths) PluginVersionInstallPath(plugin, version string) string

Functions

func GetExecutedVersion

func GetExecutedVersion(installPath string, executionPath string, pathResolver func(string) (string, error)) (string, bool, error)

GetExecutedVersion returns the currently executed version. If krew is not executed as an plugin it will return a nil error and an empty string.

func Realpath

func Realpath(path string) (string, error)

Realpath evaluates symbolic links. If the path is not a symbolic link, it returns the cleaned path. Symbolic links with relative paths return error.

Types

type Paths

type Paths struct {
	// contains filtered or unexported fields
}

Paths contains all important environment paths

func MustGetKrewPaths

func MustGetKrewPaths() Paths

MustGetKrewPaths returns the inferred paths for krew. By default, it assumes $HOME/.krew as the base path, but can be overriden via KREW_ROOT environment variable.

func (Paths) BasePath

func (p Paths) BasePath() string

BasePath returns krew base directory.

func (Paths) BinPath

func (p Paths) BinPath() string

BinPath returns the path where plugin executable symbolic links are found. This path should be added to $PATH in client machine.

e.g. {BinPath}/kubectl-foo

func (Paths) DownloadPath

func (p Paths) DownloadPath() string

DownloadPath returns a temporary directory for downloading plugins. It does not create a new directory on each call.

func (Paths) IndexPath

func (p Paths) IndexPath() string

IndexPath returns the base directory where plugin index repository is cloned.

e.g. {IndexPath}/plugins/{plugin}.yaml

func (Paths) InstallPath

func (p Paths) InstallPath() string

InstallPath returns the base directory for plugin installations.

e.g. {InstallPath}/{plugin-name}

func (Paths) PluginInstallPath

func (p Paths) PluginInstallPath(plugin string) string

PluginInstallPath returns the path to install the plugin.

e.g. {PluginInstallPath}/{version}/{..files..}

func (Paths) PluginVersionInstallPath

func (p Paths) PluginVersionInstallPath(plugin, version string) string

PluginVersionInstallPath returns the path to the specified version of specified plugin.

e.g. {PluginVersionInstallPath} = {PluginInstallPath}/{version}