run

Documentation

Index

• func NewCommand() *cobra.Command
• type Handler
  • func (h *Handler) BindFlags(cmd *cobra.Command) []string
  • func (h *Handler) Init() handler_cobra.Init
  • func (h *Handler) PreRun(ctx context.Context, args []string) error
  • func (h *Handler) Run(ctx context.Context, input handler.Input)

Functions

func NewCommand

func NewCommand() *cobra.Command

New returns a cobra command instance based on Handler.

Types

type Handler

type Handler struct {
	handler.Session

	ConfigFile string `usage:"configuration file (.json/.toml/.yaml/.yml)"`
	Op         string `usage:"Ops.Id value from the config file"`
	PlanFile   string `usage:"Dry-run mode, only write a plan file"`
	PlanField  string `usage:"(comma-separated) Include extra field(s) in the plan file: PruneGlobalIds,PruneGoFiles"`
	Progress   string `usage:"(comma-separated) Printed status message types: audit,copy,module"`

	Log     *log_zap.Mixin
	Profile *log_pprof.Mixin
	// contains filtered or unexported fields
}

Handler defines the sub-command flags and logic.

func (*Handler) BindFlags

func (h *Handler) BindFlags(cmd *cobra.Command) []string

BindFlags binds the flags to Handler fields.

It implements cli/handler/cobra.Handler.

func (*Handler) Init

func (h *Handler) Init() handler_cobra.Init

Init defines the command, its environment variable prefix, etc.

It implements cli/handler/cobra.Handler.

func (*Handler) PreRun

func (h *Handler) PreRun(ctx context.Context, args []string) error

PreRun executes after flag parsing and before Run.

If it returns an error, Run and PostRun are not executed.

It implements cli/handler.PreRun

func (*Handler) Run

func (h *Handler) Run(ctx context.Context, input handler.Input)

Run performs the sub-command logic.

It implements cli/handler/cobra.Handler.