Executus v0.3.1 Executus

A Majordomo for your OS!

Link to this section Summary

Functions

Call on Majordomo Executus to run a command

Command Executus to abandon your task

Command Executus to issue a decree to your task

Link to this section Types

Link to this type cmd_opt()
cmd_opt() ::
  {:debug, boolean()}
  | {:sync, boolean()}
  | {:cd, Path.t()}
  | {:user, String.t()}
  | {:stdout, :stderr}
  | {:stderr, :stdout}
  | {:redirect, boolean()}
Link to this type cmd_opts()
cmd_opts() :: [cmd_opt()]

Link to this section Functions

Link to this function execute(cmd, cmd_opts \\ [])
execute(String.t(), cmd_opts()) ::
  {:ok, pid()}
  | %Executus.Result{
      err: String.t() | nil,
      out: String.t() | nil,
      status: integer()
    }
  | {:error, any()}

Call on Majordomo Executus to run a command.

If async returns a PID that can be used to command Executus. If sync blocks until Executus returns the result of the command.

Link to this function halt(exec_pid)
halt(pid()) :: :ok | {pid(), :result, Map.t()} | {:error, any()}

Command Executus to abandon your task.

Executus returns the tasks final words.

Link to this function issue(exec_pid, data)
issue(pid(), String.t()) :: :ok

Command Executus to issue a decree to your task.