util_cmd

Documentation

Index

• type Command
  • func NewCommand(appAndArgs ...string) Command
  • func NewCommandA(app string, args ...string) Command
  • func (c Command) Run(ctx context.Context) (CommandResult, error)
  • func (c Command) WithApp(app string, args ...string) Command
  • func (c Command) WithCwd(cwd string) Command
  • func (c Command) WithExtraArgs(args ...string) Command
  • func (c Command) WithLogging(args ...bool) Command
  • func (c Command) WithStdErrLogging() Command
  • func (c Command) WithStdLogging() Command
  • func (c Command) WithStdOutLogging() Command
  • func (c Command) WithTimeout(timeout time.Duration) Command
  • func (c Command) WithTimeoutRetries(n int) Command
• type CommandResult

Types

type Command

type Command struct {
	Cwd  string
	App  string
	Args []string
	// You can have either a custom context or a timeout, not both
	Timeout        time.Duration
	TimeoutRetries int
	LogStdOut      bool
	LogStdErr      bool
	// debug functionality
	LogInput bool
}

func NewCommand

func NewCommand(appAndArgs ...string) Command

func NewCommandA

func NewCommandA(app string, args ...string) Command

func (Command) Run

func (c Command) Run(ctx context.Context) (CommandResult, error)

func (Command) WithApp

func (c Command) WithApp(app string, args ...string) Command

func (Command) WithCwd

func (c Command) WithCwd(cwd string) Command

func (Command) WithExtraArgs

func (c Command) WithExtraArgs(args ...string) Command

func (Command) WithLogging

func (c Command) WithLogging(args ...bool) Command

func (Command) WithStdErrLogging

func (c Command) WithStdErrLogging() Command

func (Command) WithStdLogging

func (c Command) WithStdLogging() Command

func (Command) WithStdOutLogging

func (c Command) WithStdOutLogging() Command

func (Command) WithTimeout

func (c Command) WithTimeout(timeout time.Duration) Command

func (Command) WithTimeoutRetries

func (c Command) WithTimeoutRetries(n int) Command

type CommandResult

type CommandResult struct {
	StdOut   string
	StdErr   string
	Combined string
	Err      error
	Attempts int
}