common

Documentation

Overview

Package common should not be imported by external consumers. It was not designed for external use.

Index

• Variables
• type HelpActor
• type HelpCommand
  • func (cmd HelpCommand) Execute(args []string) error
  • func (cmd *HelpCommand) Setup(config command.Config, ui command.UI) error
• type InstallPluginActor
• type InstallPluginCommand
  • func (cmd InstallPluginCommand) Execute([]string) error
  • func (cmd *InstallPluginCommand) Setup(config command.Config, ui command.UI) error
• type PluginSource
• type V2CommandList
• type VersionCommand
  • func (cmd VersionCommand) Execute(args []string) error
  • func (cmd *VersionCommand) Setup(config command.Config, ui command.UI) error

Variables

var Commands commandList

Types

type HelpActor

type HelpActor interface {
	// CommandInfoByName returns back a help command information for the given
	// command
	CommandInfoByName(interface{}, string) (sharedaction.CommandInfo, error)

	// CommandInfos returns a list of all commands
	CommandInfos(interface{}) map[string]sharedaction.CommandInfo
}

HelpActor handles the business logic of the help command

type HelpCommand

type HelpCommand struct {
	UI     command.UI
	Actor  HelpActor
	Config command.Config

	OptionalArgs flag.CommandName `positional-args:"yes"`
	AllCommands  bool             `short:"a" description:"All available CLI commands"`
	// contains filtered or unexported fields
}

func (HelpCommand) Execute

func (cmd HelpCommand) Execute(args []string) error

func (*HelpCommand) Setup

func (cmd *HelpCommand) Setup(config command.Config, ui command.UI) error

type InstallPluginActor

type InstallPluginActor interface {
	CreateExecutableCopy(path string, tempPluginDir string) (string, error)
	DownloadExecutableBinaryFromURL(url string, tempPluginDir string, proxyReader plugin.ProxyReader) (string, error)
	FileExists(path string) bool
	GetAndValidatePlugin(metadata pluginaction.PluginMetadata, commands pluginaction.CommandList, path string) (configv3.Plugin, error)
	GetPlatformString(runtimeGOOS string, runtimeGOARCH string) string
	GetPluginInfoFromRepositoriesForPlatform(pluginName string, pluginRepos []configv3.PluginRepository, platform string) (pluginaction.PluginInfo, []string, error)
	GetPluginRepository(repositoryName string) (configv3.PluginRepository, error)
	InstallPluginFromPath(path string, plugin configv3.Plugin) error
	UninstallPlugin(uninstaller pluginaction.PluginUninstaller, name string) error
	ValidateFileChecksum(path string, checksum string) bool
}

type InstallPluginCommand

type InstallPluginCommand struct {
	OptionalArgs         flag.InstallPluginArgs `positional-args:"yes"`
	SkipSSLValidation    bool                   `short:"k" hidden:"true" description:"Skip SSL certificate validation"`
	Force                bool                   `short:"f" description:"Force install of plugin without confirmation"`
	RegisteredRepository string                 `short:"r" description:"Restrict search for plugin to this registered repository"`

	UI          command.UI
	Config      command.Config
	Actor       InstallPluginActor
	ProgressBar plugin.ProxyReader
	// contains filtered or unexported fields
}

func (InstallPluginCommand) Execute

func (cmd InstallPluginCommand) Execute([]string) error

func (*InstallPluginCommand) Setup

func (cmd *InstallPluginCommand) Setup(config command.Config, ui command.UI) error

type PluginSource

type PluginSource int

const (
	PluginFromRepository PluginSource = iota
	PluginFromLocalFile
	PluginFromURL
)

type V2CommandList

type V2CommandList struct {
	V2App v6.AppCommand `command:"app" description:"Display health and status for an app"`
}

var FallbackCommands V2CommandList

type VersionCommand

type VersionCommand struct {
	UI     command.UI
	Config command.Config
	// contains filtered or unexported fields
}

func (VersionCommand) Execute

func (cmd VersionCommand) Execute(args []string) error

func (*VersionCommand) Setup

func (cmd *VersionCommand) Setup(config command.Config, ui command.UI) error