exechelper

Documentation

Index

• Constants
• func DoHeadless(command []string, env map[string]string) (int, error)
• func Lookup(bin string, extraLookupPaths []string) (string, error)
• func Prepare(s Spec) (*exec.Cmd, error)
• type Cmd
  • func Do(s Spec) (*Cmd, error)
  • func (c *Cmd) Release() error
  • func (c *Cmd) Resize(cols, rows uint32) error
  • func (c *Cmd) Wait() (int, error)
• type Spec

Constants

const (
	DefaultExitCodeOnError = 128
)

Error code for non exec error

Functions

func DoHeadless

func DoHeadless(command []string, env map[string]string) (int, error)

func Lookup

func Lookup(bin string, extraLookupPaths []string) (string, error)

func Prepare

func Prepare(s Spec) (*exec.Cmd, error)

Prepare an unstarted exec.Cmd

Types

type Cmd

type Cmd struct {
	ExecCmd *exec.Cmd

	// stdin/stdout set when created with tty enabled
	TtyInput  io.WriteCloser
	TtyOutput io.ReadCloser
	// contains filtered or unexported fields
}

func Do

func Do(s Spec) (*Cmd, error)

Do execute command directly in local host

func (*Cmd) Release

func (c *Cmd) Release() error

Release process if wait was not called and you want to terminate it

func (*Cmd) Resize

func (c *Cmd) Resize(cols, rows uint32) error

Resize tty windows if was created with tty enabled

func (*Cmd) Wait

func (c *Cmd) Wait() (int, error)

Wait until command exited

type Spec

type Spec struct {
	Context context.Context

	// set working directory when running the command
	Dir string

	Env         map[string]string
	Command     []string
	SysProcAttr *syscall.SysProcAttr

	ExtraLookupPaths []string

	// stdin/stdout/stderr streams, not used if Tty is set to true
	Stdin          io.Reader
	Stdout, Stderr io.Writer

	Tty bool
}