A release assembler for Erlang.
relx [options] [release-specification-file]
Relx assembles releases for an Erlang/OTP release. Given a release specification and a list of directories in which to search for OTP applications it will generate a release output. That output depends heavily on what plugins available and what options are defined, but usually it is simply a well configured release directory.
The release-specification-file is optional but otherwise contains additional specification information for releases.
To build relx and generate a standalone escript executable:
$ make
This creates the executable relx.
By default relx looks for relx.config in the current working directory:
{release, {relname, "vsn"},
[app1,
app2]}.
{extended_start_script, true}.| Short | Long | Type | Default | Description |
|---|---|---|---|---|
| -r | --root | string | ./ | Name for the release that will be generated |
| -v | --relvsn | string | Version for the release | |
| -g | --goal | string | A goal for the system. These are usually the OTP apps that are part of the release | |
| -u | --upfrom | string | The release to upgrade from. Only valid with relup target | |
| -o | --output-dir | string | ./ | The output directory for the release |
| -l | --lib-dir | string | Additional dirs to search for OTP apps | |
| -p | --path | string | Additional dirs to add to Erlang code path | |
| --default-libs | boolean | true | Whether to use the default system added lib dirs (means you must add them all manually) | |
| -V | --verbose | integer | 2 | The verbosity level between 0 and 3 |
| -a | --override_app | string | An app name and a directory to override in the form appname:dir | |
| -c | --config | string | ./relx.config | Config file path |