TTYCast.Recorder (ttycast v0.1.0)

Records commands running under a real pseudo-terminal.

This module is for non-interactive command recording: output from the child PTY is captured into a .ttycast file until the process exits or the optional timeout elapses.

Summary

Types

result()

Functions

record(list, opts)

Records [cmd | args] under a PTY and writes the result to opts[:path].

Types

result()

@type result() :: %{
  status: non_neg_integer(),
  path: Path.t(),
  bytes: non_neg_integer()
}

Functions

record(list, opts)

@spec record(
  [String.t()],
  keyword()
) :: {:ok, result()} | {:error, term()}

Records [cmd | args] under a PTY and writes the result to opts[:path].