ExDockerCompose v0.1.0 ExDockerCompose View Source

ExDockerCompose is an Elixir library to call docker-compose commands from Elixir. This can be used for example to write Mix tasks

Link to this section Summary

Functions

docker-compose [compose_opts] subcommand build [subcommand_opts]

Same as ExDockerCompose.build/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand bundle [subcommand_opts]

Same as ExDockerCompose.bundle/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand config [subcommand_opts]

Same as ExDockerCompose.config/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand create [subcommand_opts]

Same as ExDockerCompose.create/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand down [subcommand_opts]

Same as ExDockerCompose.down/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand events [subcommand_opts]

Same as ExDockerCompose.events/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand exec [subcommand_opts]

Same as ExDockerCompose.exec/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand help [subcommand_opts]

Same as ExDockerCompose.help/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand images [subcommand_opts]

Same as ExDockerCompose.images/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand kill [subcommand_opts]

Same as ExDockerCompose.kill/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand logs [subcommand_opts]

Same as ExDockerCompose.logs/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand pause [subcommand_opts]

Same as ExDockerCompose.pause/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand port [subcommand_opts]

Same as ExDockerCompose.port/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand ps [subcommand_opts]

Same as ExDockerCompose.ps/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand pull [subcommand_opts]

Same as ExDockerCompose.pull/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand push [subcommand_opts]

Same as ExDockerCompose.push/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand restart [subcommand_opts]

Same as ExDockerCompose.restart/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand rm [subcommand_opts]

Same as ExDockerCompose.rm/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand run [subcommand_opts]

Same as ExDockerCompose.run/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand scale [subcommand_opts]

Same as ExDockerCompose.scale/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand start [subcommand_opts]

Same as ExDockerCompose.start/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand stop [subcommand_opts]

Same as ExDockerCompose.stop/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand top [subcommand_opts]

Same as ExDockerCompose.top/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand unpause [subcommand_opts]

Same as ExDockerCompose.unpause/2, only that raises exceptions instead or returning :error tuple

docker-compose [compose_opts] subcommand up [subcommand_opts]

Same as ExDockerCompose.up/2, only that raises exceptions instead or returning :error tuple

Link to this section Functions

Link to this function build(compose_opts, opts) View Source
build(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand build [subcommand_opts].

See docker-compose docs

Parameters

Link to this function build!(compose_opts, opts) View Source
build!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.build/2, only that raises exceptions instead or returning :error tuple.

Link to this function bundle(compose_opts, opts) View Source
bundle(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand bundle [subcommand_opts].

See docker-compose docs

Parameters

Link to this function bundle!(compose_opts, opts) View Source
bundle!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.bundle/2, only that raises exceptions instead or returning :error tuple.

Link to this function config(compose_opts, opts) View Source
config(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand config [subcommand_opts].

See docker-compose docs

Parameters

Link to this function config!(compose_opts, opts) View Source
config!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.config/2, only that raises exceptions instead or returning :error tuple.

Link to this function create(compose_opts, opts) View Source
create(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand create [subcommand_opts].

See docker-compose docs

Parameters

Link to this function create!(compose_opts, opts) View Source
create!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.create/2, only that raises exceptions instead or returning :error tuple.

Link to this function down(compose_opts, opts) View Source
down(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand down [subcommand_opts].

See docker-compose docs

Parameters

Link to this function down!(compose_opts, opts) View Source
down!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.down/2, only that raises exceptions instead or returning :error tuple.

Link to this function events(compose_opts, opts) View Source
events(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand events [subcommand_opts].

See docker-compose docs

Parameters

Link to this function events!(compose_opts, opts) View Source
events!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.events/2, only that raises exceptions instead or returning :error tuple.

Link to this function exec(compose_opts, opts) View Source
exec(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand exec [subcommand_opts].

See docker-compose docs

Parameters

Link to this function exec!(compose_opts, opts) View Source
exec!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.exec/2, only that raises exceptions instead or returning :error tuple.

Link to this function help(compose_opts, opts) View Source
help(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand help [subcommand_opts].

See docker-compose docs

Parameters

Link to this function help!(compose_opts, opts) View Source
help!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.help/2, only that raises exceptions instead or returning :error tuple.

Link to this function images(compose_opts, opts) View Source
images(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand images [subcommand_opts].

See docker-compose docs

Parameters

Link to this function images!(compose_opts, opts) View Source
images!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.images/2, only that raises exceptions instead or returning :error tuple.

Link to this function kill(compose_opts, opts) View Source
kill(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand kill [subcommand_opts].

See docker-compose docs

Parameters

Link to this function kill!(compose_opts, opts) View Source
kill!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.kill/2, only that raises exceptions instead or returning :error tuple.

Link to this function logs(compose_opts, opts) View Source
logs(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand logs [subcommand_opts].

See docker-compose docs

Parameters

Link to this function logs!(compose_opts, opts) View Source
logs!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.logs/2, only that raises exceptions instead or returning :error tuple.

Link to this function pause(compose_opts, opts) View Source
pause(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand pause [subcommand_opts].

See docker-compose docs

Parameters

Link to this function pause!(compose_opts, opts) View Source
pause!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.pause/2, only that raises exceptions instead or returning :error tuple.

Link to this function port(compose_opts, opts) View Source
port(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand port [subcommand_opts].

See docker-compose docs

Parameters

Link to this function port!(compose_opts, opts) View Source
port!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.port/2, only that raises exceptions instead or returning :error tuple.

Link to this function ps(compose_opts, opts) View Source
ps(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand ps [subcommand_opts].

See docker-compose docs

Parameters

Link to this function ps!(compose_opts, opts) View Source
ps!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.ps/2, only that raises exceptions instead or returning :error tuple.

Link to this function pull(compose_opts, opts) View Source
pull(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand pull [subcommand_opts].

See docker-compose docs

Parameters

Link to this function pull!(compose_opts, opts) View Source
pull!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.pull/2, only that raises exceptions instead or returning :error tuple.

Link to this function push(compose_opts, opts) View Source
push(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand push [subcommand_opts].

See docker-compose docs

Parameters

Link to this function push!(compose_opts, opts) View Source
push!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.push/2, only that raises exceptions instead or returning :error tuple.

Link to this function restart(compose_opts, opts) View Source
restart(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand restart [subcommand_opts].

See docker-compose docs

Parameters

Link to this function restart!(compose_opts, opts) View Source
restart!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.restart/2, only that raises exceptions instead or returning :error tuple.

Link to this function rm(compose_opts, opts) View Source
rm(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand rm [subcommand_opts].

See docker-compose docs

Parameters

Link to this function rm!(compose_opts, opts) View Source
rm!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.rm/2, only that raises exceptions instead or returning :error tuple.

Link to this function run(compose_opts, opts) View Source
run(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand run [subcommand_opts].

See docker-compose docs

Parameters

Link to this function run!(compose_opts, opts) View Source
run!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.run/2, only that raises exceptions instead or returning :error tuple.

Link to this function scale(compose_opts, opts) View Source
scale(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand scale [subcommand_opts].

See docker-compose docs

Parameters

Link to this function scale!(compose_opts, opts) View Source
scale!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.scale/2, only that raises exceptions instead or returning :error tuple.

Link to this function start(compose_opts, opts) View Source
start(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand start [subcommand_opts].

See docker-compose docs

Parameters

Link to this function start!(compose_opts, opts) View Source
start!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.start/2, only that raises exceptions instead or returning :error tuple.

Link to this function stop(compose_opts, opts) View Source
stop(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand stop [subcommand_opts].

See docker-compose docs

Parameters

Link to this function stop!(compose_opts, opts) View Source
stop!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.stop/2, only that raises exceptions instead or returning :error tuple.

Link to this function top(compose_opts, opts) View Source
top(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand top [subcommand_opts].

See docker-compose docs

Parameters

Link to this function top!(compose_opts, opts) View Source
top!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.top/2, only that raises exceptions instead or returning :error tuple.

Link to this function unpause(compose_opts, opts) View Source
unpause(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand unpause [subcommand_opts].

See docker-compose docs

Parameters

Link to this function unpause!(compose_opts, opts) View Source
unpause!(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  no_return()

Same as ExDockerCompose.unpause/2, only that raises exceptions instead or returning :error tuple.

Link to this function up(compose_opts, opts) View Source
up(compose_opts :: List.t(), opts :: List.t()) ::
  :ok |
  {:error, reason :: String.t()}

docker-compose [compose_opts] subcommand up [subcommand_opts].

See docker-compose docs

Parameters

Link to this function up!(compose_opts, opts) View Source
up!(compose_opts :: List.t(), opts :: List.t()) :: :ok | no_return()

Same as ExDockerCompose.up/2, only that raises exceptions instead or returning :error tuple.