rebar 3.0 is an Erlang build tool that makes it easy to compile and test Erlang applications, port drivers and releases.

rebar is a self-contained Erlang script, so it's easy to distribute or even embed directly in a project. Where possible, rebar uses standard Erlang/OTP conventions for project structures, thus minimizing the amount of build configuration work. rebar also provides dependency management, enabling application writers to easily re-use common libraries from a variety of locations (hex.pm, git, hg, and so on).

DOCUMENTATION

A more complete list can be found on the docs page

• Fetches and builds deps if missing when running any command that relies on them
• Automatically recognizes apps and lib directory structure
• Relx for releases and relups
• deterministic builds and conflict resolution
• New plugin handling mechanism
• New hook mechanism
• Support for packages
• A ton more

• Reltool integeration
• Quickcheck integration (moved to a plugin)
• C code compiling (moved to a plugin or hooks)

Providers are the modules that do the work to fulfill a user's command.

Example:

-module(rebar_prv_something).

-behaviour(rebar_provider).

-export([init/1,
         do/1,
         format_error/1]).

-define(PROVIDER, something).
-define(DEPS, []).

%% ===================================================================
%% Public API
%% ===================================================================

-spec init(rebar_state:state()) -> {ok, rebar_state:state()}.
init(State) ->
    State1 = rebar_state:add_provider(State, rebar_provider:create([{name, ?PROVIDER},
                                                                    {module, ?MODULE},
                                                                    {bare, false},
                                                                    {deps, ?DEPS},
                                                                    {example, "rebar dummy"},
                                                                    {short_desc, "dummy plugin."},
                                                                    {desc, ""},
                                                                    {opts, []}])),
    {ok, State1}.

-spec do(rebar_state:state()) -> {ok, rebar_state:state()}.
do(State) ->
    %% Do something
    {ok, State}.

-spec format_error(any()) -> iolist().
format_error(Reason) ->
    io_lib:format("~p", [Reason]).

Recommended installation of Erlang/OTP is source built using erln8 or kerl. For binary packages use those provided by Erlang Solutions, but be sure to choose the "Standard" download option or you'll have issues building projects.

To build rebar you will need a working installation of Erlang R15 (or later).

Should you want to clone the rebar repository, you will also require git.

You can download a pre-built binary version of rebar3 based on the last commit from:

https://s3.amazonaws.com/rebar3/rebar3

$ git clone https://github.com/rebar/rebar3
$ cd rebar3
$ ./bootstrap

When developing you can simply run escriptize to build your changes but the new escript is under _build/default/bin/rebar3

$ ./rebar3 escriptize
$ _build/default/bin/rebar3

Please refer to CONTRIBUTING.

In case of problems that cannot be solved through documentation or examples, you may want to try to contact members of the community for help. The community is also where you want to go for questions about how to extend rebar, fill in bug reports, and so on.

The main place to go for questions is the rebar mailing list. If you need quick feedback, you can try the #rebar channel on irc.freenode.net. Be sure to check the documentation first, just to be sure you're not asking about things with well known answers.

For bug reports, roadmaps, and issues, visit the github issues page.

General rebar community resources and links:

• Rebar Mailing List
• #rebar on irc.freenode.net
• issues
• Documentation