HostKit.Host (host_kit v0.1.0-beta.1)

Copy Markdown View Source

Host declaration.

Summary

Types

t()

Functions

remote_options(host)
ssh_options(host, overrides \\ [])
target_opts(host, overrides \\ [])

Types

t()

@type t() :: %HostKit.Host{
  hostname: String.t() | nil,
  meta: map(),
  name: atom(),
  sudo: boolean(),
  user: String.t() | nil
}

Functions

remote_options(host)

@spec remote_options(t()) :: keyword()

ssh_options(host, overrides \\ [])

@spec ssh_options(
  t(),
  keyword()
) :: keyword()

target_opts(host, overrides \\ [])

@spec target_opts(
  t(),
  keyword()
) :: keyword()