plugins

Documentation

Index

• Constants
• type Manager
  • func NewManager() (*Manager, error)
  • func (m *Manager) Run(args []string) error
  • func (m *Manager) ShouldRun(name string) bool

Constants

const (
	// DefaultPluginPrefix is the default prefix for the plugin binary name.
	DefaultPluginPrefix = "gtctl-"

	// PluginSearchPathsEnvKey is the environment variable key for the plugin search paths.
	// If we set this variable, the plugin manager will search the paths provided by this variable.
	// If we don't set this variable, the plugin manager will search the current working directory and the $PATH.
	PluginSearchPathsEnvKey = "GTCTL_PLUGIN_PATHS"
)

Types

type Manager

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

Manager manages and executes the plugins.

func NewManager

func NewManager() (*Manager, error)

func (*Manager) Run

func (m *Manager) Run(args []string) error

Run searches for the plugin and runs it.

func (*Manager) ShouldRun

func (m *Manager) ShouldRun(name string) bool

ShouldRun returns true whether you should run the plugin.