rebar3



Build better Erlang.

Getting Started

Backwards Compatibility

We attempt very limited backwards compatibility with previous rebar versions' configurations and will try to call out important changes in the documentation.

Installing Binary

Download a nightly binary here. Ensure it is executable (chmod +x) and simply copy to a directory in your $PATH.

It is common to create a directory ~/bin/ to place commands like rebar3 and add it to your path with export PATH=~/bin/:$PATH in your ~/.bashrc, ~/.zshrc or equivalent.

Installing from Source

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

And now you have the script rebar3 and can copy it to somewhere in your $PATH as described in the previous section.

Extracting and Upgrading

An additional way to install and run rebar3 can be found under the local namespace. rebar3 local install will extract the contents of the escript to ~/.cache/rebar3/lib and create a shell script ~/.cache/rebar3/bin/rebar3:

$ ./rebar3 local install
===> Extracting rebar3 libs to ~/.cache/rebar3/lib...
===> Writing rebar3 run script ~/.cache/rebar3/bin/rebar3...
===> Add to $PATH for use: export PATH=$PATH:~/.cache/rebar3/bin

Plus, rebar3 unstable upgrade will fetch the latest escript from s3 and install the same way:

$ rebar3 local upgrade
===> Extracting rebar3 libs to ~/.cache/rebar3/lib...
===> Writing rebar3 run script ~/.cache/rebar3/bin/rebar3...
===> Add to $PATH for use: export PATH=$PATH:~/.cache/rebar3/bin

Creating a New Project

$ rebar3 new release myrelease
===> Writing apps/myrelease/src/myrelease_app.erl
===> Writing apps/myrelease/src/myrelease_sup.erl
===> Writing apps/myrelease/src/myrelease.app.src
===> Writing rebar.config
===> Writing config/sys.config
===> Writing config/vm.args
===> Writing .gitignore
===> Writing LICENSE
===> Writing README.md

Continue on to Basic Usage to learn more on how to use rebar3.

Getting Started