Installation

Jorel can be use as a command line tool, as an erlang.mk plugin, a rebar3 plugin or as a mix task.

Jorel does not work on Windows (yet).

Command line

To use Jorel in command line, download Jorel, make it executable and place it in your PATH.

You will need a release specification file.

You can now use Jorel by invoking it in your terminal.

jorel [command] [options]

See commands and options for more information.

erlang.mk plugin

To use the erlang.mk plugins, add Jorel as a build (BUILD_DEPS) and plugin (DEP_PLUGINS) dependency in your Makefile.

DEP_PLUGINS = jorel
BUILD_DEPS = jorel
dep_jorel = git https://github.com/emedia-project/jorel.git master

As when using Jorel as a command line tool, you can create a release specification file.

When using the erlang.mk plugin, if the release specification file does not exist, Jorel will automaticaly create it by invoking the gen_config provider.

Then you can run make jorel.release to create a release with Jorel.

You can invoke any provider by using the jorel.exec target and passing the provider to use with the cmd parameter.

make jorel.exec cmd=tar

The jorel.exec target accept the following parameters :

make jorel.exec cmd=tar c=custom.config o=_rel

Rebar3 plugin

To use Jorel with rebar3, add rebar3_jorel in the plugin section :

{plugins, [rebar3_jorel]}.

or

{plugins, [
  {rebar3_jorel, {git, "https://github.com/emedia-project/rebar3_jorel.git"}}
]}.

This add the following tasks to rebar3 :

With renar3_jorel, the configuration is placed in your rebar.config file, under the jorel section. See release specification file for more information.

If you do not specify any configuration information, Jorel will generate a default one when you run a Jorel with rebar3.

Mix task

To use Jorel in an Elixir project, you can use jorel_mix.

Add jorel_mix in your project dependencies.

{:jorel_mix, "~> 0.0.1"}

# or

{:jorel_mix, ~r/.*/, git: "https://github.com/emedia-project/jorel_mix.git", branch: "master"},

This dependencie add the following tasks to your mix :

With jorel_mix, the configuration is placed in your mix.exs file, returned by the jorel function. See release specification file for more information.

If you do not specify any configuration information, Jorel will generate a default one when you run a Jorel with mix.