shell

Documentation

Overview

Package shell handles interactions with the OS shell

Index

• Constants
• type Execute
  • func (e *Execute) ExecuteWithValue(method *config.Method, value string) (string, error)
  • func (e *Execute) GetType() string

Constants

const Type = "shell"

Type shell represents a shell command

Types

type Execute

type Execute struct {
	Command command
}

Execute represents a way to execute shell commands with values piped to them.

func (*Execute) ExecuteWithValue

func (e *Execute) ExecuteWithValue(method *config.Method, value string) (string, error)

ExecuteWithValue executes a shell command with a value piped to it. If it exits with code 0, no error is returned and the stdout is captured and returned. If it exits with code 1, an error is returned and the stderr is captured and returned. If the timeout is reached, an error is returned.

func (*Execute) GetType

func (e *Execute) GetType() string

GetType returns the shell executer type