AmpSdk.Command (AmpSdk v0.6.0)

Copy Markdown View Source

Synchronous Amp command helpers built on the shared core command lane.

Summary

Types

run_opt()

Functions

run(args, opts \\ [])
run(command, args, opts)

Types

run_opt()

@type run_opt() ::
  {:timeout, non_neg_integer() | :infinity}
  | {:stdin, iodata()}
  | {:stderr_to_stdout, boolean()}
  | {:trim_output, boolean()}
  | {:cd, String.t()}
  | {:env, map() | keyword()}
  | {:execution_surface,
     CliSubprocessCore.ExecutionSurface.t() | map() | keyword()}
  | {:governed_authority,
     CliSubprocessCore.GovernedAuthority.t() | map() | keyword()}

Functions

run(args, opts \\ [])

@spec run([String.t()], [run_opt()]) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

run(command, args, opts)

@spec run(CliSubprocessCore.CommandSpec.t(), [String.t()], [run_opt()]) ::
  {:ok, String.t()} | {:error, AmpSdk.Error.t()}