plugin

Documentation

Index

• Constants
• type Help
  • func (h *Help) Long()
  • func (h *Help) Short()
• type Plugin
  • func (p *Plugin) GetMetadata() cfplugin.PluginMetadata
  • func (p *Plugin) Help(name string)
  • func (p *Plugin) Install() error
  • func (p *Plugin) Run(cliConnection cfplugin.CliConnection, args []string)
• type UI

Constants

const LongUsage = `` /* 5074-byte string literal not displayed */

const ShortUsage = `` /* 427-byte string literal not displayed */

const Usage = ShortUsage + "\n" + LongUsage

Types

type Help

type Help struct {
	CLI cfplugin.CliConnection
	UI  UI
}

func (*Help) Long

func (h *Help) Long()

func (*Help) Short

func (h *Help) Short()

type Plugin

type Plugin struct {
	UI      UI
	Version string
	RunErr  error
	Exit    <-chan struct{}
}

func (*Plugin) GetMetadata

func (p *Plugin) GetMetadata() cfplugin.PluginMetadata

func (*Plugin) Help

func (p *Plugin) Help(name string)

func (*Plugin) Install

func (p *Plugin) Install() error

func (*Plugin) Run

func (p *Plugin) Run(cliConnection cfplugin.CliConnection, args []string)

type UI

type UI interface {
	Prompt(prompt string) string
	Output(format string, a ...interface{})
	Warn(format string, a ...interface{})
	Error(err error)
	Loading(message string, progress <-chan engine.Progress) error
}