plugin

Documentation

Index

• func GetPluginBinPath(installed types.InstalledPlugin) string
• func GetPluginMetadataFromGithub(name string) (types.PluginMetadata, error)
• func GetPluginMetadataFromLocalCache(name string) (types.PluginMetadata, error)
• func GetPluginsList(nameOnly bool) ([]string, error)
• func GetPluginsListFromLocalCache(nameOnly bool) ([]string, error)
• func GetPluginsListFromPath(nameOnly bool) ([]string, error)
• func InstallPlugin(plugin types.PluginMetadata) error
• func InstallPluginFromGithub(name string) error
• func SelectProperVersionAndPlatform(plugin types.PluginMetadata) (types.PluginVersionMetadata, types.PluginVersionForPlatform, error)
• func UninstallBrokenPlugins() error
• func UninstallPlugin(name string) error

Functions

func GetPluginBinPath

func GetPluginBinPath(installed types.InstalledPlugin) string

GetPluginBinPath returns the path to the plugin's entrypoint.

func GetPluginMetadataFromGithub

func GetPluginMetadataFromGithub(name string) (types.PluginMetadata, error)

GetPluginMetadataFromGithub returns the plugin metadata from the Github repo.

func GetPluginMetadataFromLocalCache

func GetPluginMetadataFromLocalCache(name string) (types.PluginMetadata, error)

GetPluginMetadataFromLocalCache returns the plugin metadata from the storage directory.

func GetPluginsList

func GetPluginsList(nameOnly bool) ([]string, error)

GetPluginsList looks for plugins in the given paths.

func GetPluginsListFromLocalCache

func GetPluginsListFromLocalCache(nameOnly bool) ([]string, error)

GetPluginsListFromLocalCache gets all the plugins in the storage directory.

func GetPluginsListFromPath

func GetPluginsListFromPath(nameOnly bool) ([]string, error)

GetPluginsListFromPath get all the plugins with a valid prefix that are on the PATH.

func InstallPlugin

func InstallPlugin(plugin types.PluginMetadata) error

InstallPlugin installs a plugin given the the plugin metadata.

func InstallPluginFromGithub

func InstallPluginFromGithub(name string) error

InstallPluginFromGithub downloads and installs a plugin from the Github repo.

func SelectProperVersionAndPlatform

func SelectProperVersionAndPlatform(plugin types.PluginMetadata) (types.PluginVersionMetadata, types.PluginVersionForPlatform, error)

SelectProperVersionAndPlatform selects an appropriate version and platform for the plugin.

func UninstallBrokenPlugins

func UninstallBrokenPlugins() error

UninstallBrokenPlugins uninstalls any broken plugins not mentioned in the cache.

func UninstallPlugin

func UninstallPlugin(name string) error

UninstallPlugin uninstalls an installed plugin.