plugin

Documentation

Index

• Constants
• Variables
• func Run(makeCmd func(command.Cli) *cobra.Command, meta manager.Metadata)
• func RunPlugin(dockerCli *command.DockerCli, plugin *cobra.Command, meta manager.Metadata) error
• func RunningStandalone() bool

Constants

const CLIPluginSocketEnvKey = "DOCKER_CLI_PLUGIN_SOCKET"

CLIPluginSocketEnvKey is used to pass the plugin being executed the abstract socket name it should listen on to know when the CLI has exited.

Variables

var PersistentPreRunE func(*cobra.Command, []string) error

PersistentPreRunE must be called by any plugin command (or subcommand) which uses the cobra `PersistentPreRun*` hook. Plugins which do not make use of `PersistentPreRun*` do not need to call this (although it remains safe to do so). Plugins are recommended to use `PersistenPreRunE` to enable the error to be returned. Should not be called outside of a command's PersistentPreRunE hook and must not be run unless Run has been called.

Functions

func Run

func Run(makeCmd func(command.Cli) *cobra.Command, meta manager.Metadata)

Run is the top-level entry point to the CLI plugin framework. It should be called from your plugin's `main()` function.

func RunPlugin

func RunPlugin(dockerCli *command.DockerCli, plugin *cobra.Command, meta manager.Metadata) error

RunPlugin executes the specified plugin command

func RunningStandalone

func RunningStandalone() bool

RunningStandalone tells a CLI plugin it is run standalone by direct execution