Top Level Namespace

Defined Under Namespace

Modules: Exeggutor

Instance Method Summary collapse

Instance Method Details

#run! ⇒ ProcessResult

Executes a command with the provided arguments and options

Parameters:

  • args (Array<String>) —

    The command and its arguments as an array.

  • can_fail (Boolean) —

    If false, raises a ProcessError on failure.

  • show_stdout (Boolean) —

    If true, prints stdout to the console in real-time.

  • show_stderr (Boolean) —

    If true, prints stderr to the console in real-time.

  • cwd (String, nil) —

    The working directory to run the command in. If nil, uses the current working directory.

  • stdin_data (String, nil) —

    Input data to pass to the command’s stdin. If nil, doesn’t pass any data to stdin.

  • env_vars (Hash{String => String}, nil) —

    A hashmap containing environment variable overrides, or ‘nil` if no overrides are desired

Returns:

  • (ProcessResult) —

    An object containing process info such as stdout, stderr, and exit code. Waits for the command to complete to return.

Raises:

  • (ProcessError) —

    If the command fails and ‘can_fail` is false.



131
132
133
 
# File 'lib/exeggutor.rb', line 131

def run!(...)
  Exeggutor::run!(...)
end