rebar

rebar 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 (git, hg, etc).

3.0

This is an experimental branch.

Commands

Command	Description
compile	Build project
update	Update package index
pkgs	List available packages
shell	Run shell with project apps in path
escriptize	Create escript from project
new	Create new rebar project from templates
do	Higher-order provider to run multiple tasks in sequence

The following commands are still in the works.

Command	Description
release	Build release of project
tar	Package release into tarball
eunit
ct

Missing

• Pre and post hooks
• Compilers besides erlc

Changes

• Fetches and builds deps if missing when running any command that relies on them
• Automatically recognizes apps and libs directory structure
• escriptize requires escript_top_level_app set in rebar.config
• Relx for releases

Gone

• Reltool integeration

Providers

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]).

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

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

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

-spec do(rebar_config:config()) -> {ok, rebar_config:config()}.
do(Config) ->
    %% Do something
    {ok, Config}.

Building

Information on building and installing Erlang/OTP can be found here (more info).

Dependencies

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

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

Downloading

You can download a pre-built binary version of rebar from:

https://github.com/rebar/rebar/wiki/rebar

Building rebar

$ git clone git://github.com/rebar/rebar.git
$ cd rebar
$ ./bootstrap/bootstrap
Recompile: src/getopt
...
Recompile: src/rebar_utils
==> rebar (compile)
Congratulations! You now have a self-contained script called "rebar" in
your current working directory. Place this script anywhere in your path
and you can use rebar to build OTP-compliant apps.

Contributing to rebar

Please refer to CONTRIBUTING.

Community and Resources

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 wiki 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
• wiki
• issues