Module relx

do(Opts::proplists:proplist(), NonOpts::[string()]) -> ok | error() | {ok, rlx_state:t()}

Opts:

- A proplist of options. There are good defaults for each of these entries, so any or all may be omitted. Individual options may be:

{relname, RelName}

The release name to build

{relvsn, RelVsn}

The release version to build

{goals, Goals}

The release goals for the system in depsolver or Relx goal format (@see goals())

{lib_dirs, LibDirs}

A list of library dirs that should be used for the system

{lib_dir, LibDir}

A single lib dir that should be used for the system, may appear any number of times and may be used in conjunction with lib_dirs

{output_dir, OutputDir}

The directory where the release should be built to

{root_dir, RootDir}

The base directory for this run of relx.

{config, Config}

The path to a relx config file

{log_level, LogLevel}

Defines the verbosity of output. Maybe a number between 0 and 2, with with higher values being more verbose

{overrides, Overrides}

A list of app overrides for the system in the form of [{AppName:atom(), Dir:string() | binary()} | string() | binary()] where the string or binary is in the form "AppName:AppDir"

{override, Override}

A single of app override for the system in the same form as entries for Overrides

do(RelName::atom(), RelVsn::string(), Goals::[goal()], LibDirs::[file:name()], LogLevel::ec_cmd_log:log_level(), OutputDir::[file:name()], Config::file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}

RelName: - The release name to build (maybe undefined)
RelVsn: - The release version to build (maybe undefined)
Goals: - The release goals for the system in depsolver or Relx goal format
LibDirs: - The library dirs that should be used for the system
OutputDir: - The directory where the release should be built to

do(RootDir::file:name(), RelName::atom(), RelVsn::string(), Goals::[goal()], LibDirs::[file:name()], LogLevel::ec_cmd_log:log_level(), OutputDir::[file:name()], Configs::file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}

RootDir: - The root directory for the project
RelName: - The release name to build (maybe undefined)
RelVsn: - The release version to build (maybe undefined)
Goals: - The release goals for the system in depsolver or Relx goal format
LibDirs: - The library dirs that should be used for the system
OutputDir: - The directory where the release should be built to
Configs: - The list of config files for the system

do(RootDir::file:name(), RelName::atom(), RelVsn::string(), Goals::[goal()], LibDirs::[file:name()], LogLevel::ec_cmd_log:log_level(), OutputDir::[file:name()], Overrides::[{atom(), file:name()}], Config::file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}

RootDir: - The root directory for the system
RelName: - The release name to build (maybe undefined)
RelVsn: - The release version to build (maybe undefined)
Goals: - The release goals for the system in depsolver or Relx goal format
LibDirs: - The library dirs that should be used for the system
OutputDir: - The directory where the release should be built to
Overrides: - A list of overrides for the system

format_error(Reason::term()) -> string()

main(Args::[string()]) -> ok | error() | {ok, rlx_state:t()}

main(ApiOptions, Args) -> any()

opt_spec_list() -> [getopt:option_spec()]