ExDockerCompose v0.2.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
docker-compose
[compose_opts] subcommand build [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.build/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand bundle [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.bundle/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand config [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.config/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand create [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.create/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand down [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.down/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand events [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.events/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand exec [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.exec/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand help [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.help/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand images [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.images/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand kill [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.kill/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand logs [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.logs/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand pause [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.pause/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand port [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.port/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand ps [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.ps/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand pull [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.pull/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand push [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.push/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand restart [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.restart/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand rm [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.rm/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand run [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.run/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand scale [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.scale/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand start [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.start/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand stop [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.stop/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand top [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.top/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand unpause [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.unpause/2
, only that raises
exceptions instead or returning :error
tuple.
docker-compose
[compose_opts] subcommand up [subcommand_opts].
Parameters
compose_opts
- options fordocker-compose
binary, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.opts
- options for the subcommand, seeExDockerCompose.Subcommands.build_command/4
for expected formatting.
Same as ExDockerCompose.up/2
, only that raises
exceptions instead or returning :error
tuple.