JumarCli (Jumar v0.1.0)

View Source

The JumarCli module contains custom commands that are used by mix release and the generated Docker file. This allows us to use the Elixir OptionParser for a more advanced CLI interface.

Summary

Functions

moduledoc()

Returns help text for Jumar CLI. This is returned when doing --help or -h. Note that this help text includes some commands that are setup in the jumar shell script outside of Elixir.

run(args)

Runs a Jumar CLI command. Will always return an ok tuple with either a pid for a long running process, or a non negative integer for a cli exit code.

Functions

moduledoc()

Returns help text for Jumar CLI. This is returned when doing --help or -h. Note that this help text includes some commands that are setup in the jumar shell script outside of Elixir.

run(args)

@spec run(String.t() | JumarCli.Command.args()) ::
  {:ok, non_neg_integer()} | {:ok, pid()}

Runs a Jumar CLI command. Will always return an ok tuple with either a pid for a long running process, or a non negative integer for a cli exit code.

Examples 

iex> JumarCli.run("migrate")
{:ok, 0}