plugin

Documentation

Overview

Package plugins provides support for creating extensible CLIs

Index

• Variables
• func Exec(md *Metadata, args []string) error
• func FindAll() map[string]*Metadata
• func SearchRegistries(cmd string) (string, bool)
• type Metadata
  • func Find(pluginName string) (*Metadata, error)
  • func (md *Metadata) AddAlias(alias string)
  • func (md *Metadata) HasAlias(needle string) bool

Variables

var (
	ErrPluginNotFound = errors.New("plugin not found")
	ErrPluginInvalid  = errors.New("invalid plugin")

	Prefix = "kubefaas-"
)

Functions

func Exec

func Exec(md *Metadata, args []string) error

Exec executes the plugin using the provided args. All input and output is redirected to stdin, stdout, and stderr.

func FindAll

func FindAll() map[string]*Metadata

FindAll searches the machine for all plugins currently present.

func SearchRegistries

func SearchRegistries(cmd string) (string, bool)

SearchRegistries will search (remote) registries for the presence of the command. For now we only use the builtinRegistry

Types

type Metadata

type Metadata struct {
	Name    string   `json:"name,omitempty"`
	Version string   `json:"version,omitempty"`
	Aliases []string `json:"aliases,omitempty"`
	Usage   string   `json:"usage,omitempty"`
	Path    string   `json:"path,omitempty"`
}

ObjectMeta contains the metadata of a plugin. The only metadata that is guaranteed to be non-empty is the path and Name. All other fields are considered optional.

func Find

func Find(pluginName string) (*Metadata, error)

Find searches the machine for the given plugin, returning the metadata of the plugin. The only metadata that is guaranteed to be non-empty is the path and Name. All other fields are considered optional. If found it returns the plugin, otherwise it returns ErrPluginNotFound if the plugin was not found.

func (*Metadata) AddAlias

func (md *Metadata) AddAlias(alias string)

func (*Metadata) HasAlias

func (md *Metadata) HasAlias(needle string) bool