Documentation
¶
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)
- func RunCLICommandHooks(ctx context.Context, dockerCLI config.Provider, ...)
- func RunPluginHooks(ctx context.Context, dockerCLI config.Provider, ...)
- type HookPluginDatadeprecated
- type Plugin
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddPluginCommandStubs ¶
AddPluginCommandStubs adds a stub cobra.Commands for each valid and invalid plugin. The command stubs will have several annotations added, see `CommandAnnotationPlugin*`.
func IsPluginCommand ¶
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.
func RunCLICommandHooks ¶
func RunCLICommandHooks(ctx context.Context, dockerCLI config.Provider, rootCmd, subCommand *cobra.Command, cmdErrorMessage string)
RunCLICommandHooks is the entrypoint into the hooks execution flow after a main CLI command was executed. It calls the hook subcommand for all present CLI plugins that declare support for hooks in their metadata and parses/prints their responses.