plugin

Documentation

Index

• func Uninstall(name string) error
• type Platform
• type Plugin
  • func Install(ctx context.Context, url string, force bool) (Plugin, error)
  • func LoadAll() ([]Plugin, error)
  • func (p Plugin) Run(ctx context.Context, args []string) error
• type Selector

Functions

func Uninstall

func Uninstall(name string) error

Uninstall installs the plugin

Types

type Platform

type Platform struct {
	Selector *Selector
	URI      string
	Bin      string
}

Platform represents where the execution file exists per platform.

type Plugin

type Plugin struct {
	Name        string     `yaml:"name"`
	Repository  string     `yaml:"repository"`
	Version     string     `yaml:"version"`
	Usage       string     `yaml:"usage"`
	Description string     `yaml:"description"`
	Platforms   []Platform `yaml:"platforms"`

	// runtime environment for testability
	GOOS   string `yaml:"_goos"`
	GOARCH string `yaml:"_goarch"`
}

Plugin represents a plugin.

func Install

func Install(ctx context.Context, url string, force bool) (Plugin, error)

Install installs a plugin

func LoadAll

func LoadAll() ([]Plugin, error)

LoadAll loads all plugins

func (Plugin) Run

func (p Plugin) Run(ctx context.Context, args []string) error

Run runs the plugin

type Selector

type Selector struct {
	OS   string
	Arch string
}

Selector represents the environment.