ra v0.3.2 Ra
Summary
Macros
Defines the banner to use when showing the help
Defines and describes a subcommand
Defines and describes an option
Reassembles all the stuff configured beforehand
Macros
Defines and describes a subcommand.
You have do provide at least the name
of the command as a string and the
function f
that shall be called when this command is given.
Also you can provide an optional description
which will be displayed when
showing the help.
The function f
needs to accept a single argument, beeing a three-tuple:
{arguments, options, config}
.
Defines and describes an option.
You have to provide at least the name
of the option, also you can define
its type
(:string
is assumed as a default) and also you can optionally
provide an description
, the description is shown when the help is printed.
Remember, when you want to have a description
, you also need to provide the
type
.
type
may be one of the following atoms:
:string
if the options value is supposed to be a string (default):integer
if the options value is supposed to be an integer:float
if the options value is supposed to be a float:boolean
if the option is meant to be an on/off-switch. One can use--opt
/--no-opt
syntax for them.
Reassembles all the stuff configured beforehand.
This macro needs to be used last in the module.
It is also responsible for creating the run
function needed by Elixir.
WARNING
This is only an interims solution and will be removed until version 0.4.0, since there is currently no alternative implemented, there is also no deprecation warning raised!