cmdutil

Documentation

Overview

Package cmdutil is expected to be used for running potentially destructive commands with a user confirmation.

Index

• func Run(ctx context.Context, cmds []*exec.Cmd, opts *RunOpts) error
• func RunWithCobra(ctx context.Context, cmds []*exec.Cmd, cobraCmd *cobra.Command) error
• type RunOpts
  • func RunOptsFromCobra(cmd *cobra.Command) (*RunOpts, error)
  • func RunOptsFromCobraNoStdin(cmd *cobra.Command) (*RunOpts, error)

Functions

func Run

func Run(ctx context.Context, cmds []*exec.Cmd, opts *RunOpts) error

func RunWithCobra

func RunWithCobra(ctx context.Context, cmds []*exec.Cmd, cobraCmd *cobra.Command) error

Types

type RunOpts

type RunOpts struct {
	Confirm bool
	Stdin   io.Reader
	Stdout  io.Writer
	Stderr  io.Writer
}

func RunOptsFromCobra

func RunOptsFromCobra(cmd *cobra.Command) (*RunOpts, error)

func RunOptsFromCobraNoStdin

func RunOptsFromCobraNoStdin(cmd *cobra.Command) (*RunOpts, error)

RunOptsFromCobraNoStdin is similar to RunOptsFromCobra but for non-destructive commands.