package manager

import "github.com/docker/cli/cli-plugins/manager"

Index ¶

• func AddPluginCommandStubs(dockerCLI config.Provider, rootCmd *cobra.Command) (err error)
• func IsPluginCommand(cmd *cobra.Command) bool
• func PluginRunCommand(dockerCli config.Provider, name string, rootcmd *cobra.Command) (*exec.Cmd, error)
• type Plugin
• func GetPlugin(name string, dockerCLI config.Provider, rootcmd *cobra.Command) (*Plugin, error)
• func ListPlugins(dockerCli config.Provider, rootcmd *cobra.Command) ([]Plugin, error)
• func (p *Plugin) MarshalJSON() ([]byte, error)
• func (p *Plugin) RunHook(ctx context.Context, hookData hooks.Request) ([]byte, error)

Functions ¶

func AddPluginCommandStubs ¶

func AddPluginCommandStubs(dockerCLI config.Provider, rootCmd *cobra.Command) (err error)

AddPluginCommandStubs adds a stub cobra.Commands for each valid and invalid plugin. The command stubs will have several annotations added, see `CommandAnnotationPlugin*`.

func IsPluginCommand ¶

func IsPluginCommand(cmd *cobra.Command) bool

IsPluginCommand checks if the given cmd is a plugin-stub.

func PluginRunCommand ¶

func PluginRunCommand(dockerCli config.Provider, name string, rootcmd *cobra.Command) (*exec.Cmd, error)

PluginRunCommand returns an os/exec.Cmd which when os/exec.Cmd.Run will execute the named plugin. The rootcmd argument is referenced to determine the set of builtin commands in order to detect conflicts. The error returned satisfies the errdefs.IsNotFound predicate if no plugin was found or if the first candidate plugin was invalid somehow.

Types ¶

type Plugin ¶

type Plugin struct {
	metadata.Metadata

	Name string `json:",omitempty"`
	Path string `json:",omitempty"`

	// Err is non-nil if the plugin failed one of the candidate tests.
	Err error `json:",omitempty"`

	// ShadowedPaths contains the paths of any other plugins which this plugin takes precedence over.
	ShadowedPaths []string `json:",omitempty"`
}

Plugin represents a potential plugin with all it's metadata.

func GetPlugin ¶

func GetPlugin(name string, dockerCLI config.Provider, rootcmd *cobra.Command) (*Plugin, error)

GetPlugin returns a plugin on the system by its name

func ListPlugins ¶

func ListPlugins(dockerCli config.Provider, rootcmd *cobra.Command) ([]Plugin, error)

ListPlugins produces a list of the plugins available on the system

func (*Plugin) MarshalJSON ¶

func (p *Plugin) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler to handle marshaling the [Plugin.Err] field (Go doesn't marshal errors by default).

func (*Plugin) RunHook ¶

func (p *Plugin) RunHook(ctx context.Context, hookData hooks.Request) ([]byte, error)

RunHook executes the plugin's hooks command and returns its unprocessed output.

Source Files ¶

candidate.go cobra.go manager.go manager_unix.go plugin.go suffix_unix.go telemetry.go