sh

Documentation

Overview

package sh provides a convenience interface to issue shell commands.

Index

• type Runner
  • func New(opts ...RunnerOption) *Runner
  • func (r *Runner) Bash(script ...string) error
  • func (r *Runner) Copy(dst, src string) error
  • func (r *Runner) New(opts ...RunnerOption) *Runner
  • func (r *Runner) Output(cmd string, args ...string) (string, error)
  • func (r *Runner) Run(cmd string, args ...string) error
• type RunnerOption
• type WithCombinedOutput
  • func (out WithCombinedOutput) ApplyToRunner(r *Runner)
• type WithEnvironment
  • func (e WithEnvironment) ApplyToRunner(r *Runner)
• type WithLogger
  • func (l WithLogger) ApplyToRunner(r *Runner)
• type WithStderr
  • func (stderr WithStderr) ApplyToRunner(r *Runner)
• type WithStdout
  • func (stdout WithStdout) ApplyToRunner(r *Runner)
• type WithWorkDir
  • func (wd WithWorkDir) ApplyToRunner(r *Runner)

Types

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...RunnerOption) *Runner

func (*Runner) Bash

func (r *Runner) Bash(script ...string) error

func (*Runner) Copy

func (r *Runner) Copy(dst, src string) error

func (*Runner) New

func (r *Runner) New(opts ...RunnerOption) *Runner

func (*Runner) Output

func (r *Runner) Output(cmd string, args ...string) (string, error)

func (*Runner) Run

func (r *Runner) Run(cmd string, args ...string) error

type RunnerOption

type RunnerOption interface {
	ApplyToRunner(r *Runner)
}

type WithCombinedOutput

type WithCombinedOutput struct{ io.Writer }

func (WithCombinedOutput) ApplyToRunner

func (out WithCombinedOutput) ApplyToRunner(r *Runner)

type WithEnvironment

type WithEnvironment map[string]string

func (WithEnvironment) ApplyToRunner

func (e WithEnvironment) ApplyToRunner(r *Runner)

type WithLogger

type WithLogger struct{ *slog.Logger }

func (WithLogger) ApplyToRunner

func (l WithLogger) ApplyToRunner(r *Runner)

type WithStderr

type WithStderr struct{ io.Writer }

func (WithStderr) ApplyToRunner

func (stderr WithStderr) ApplyToRunner(r *Runner)

type WithStdout

type WithStdout struct{ io.Writer }

func (WithStdout) ApplyToRunner

func (stdout WithStdout) ApplyToRunner(r *Runner)

type WithWorkDir

type WithWorkDir string

func (WithWorkDir) ApplyToRunner

func (wd WithWorkDir) ApplyToRunner(r *Runner)