--all/-a

none

Clean all apps, including the dependencies

--profile/-p

string

Specify a profile (alternative to rebar3 as $profile clean)

--dir

Comma separated list of strings

Compile and run all test suites in the specified directories.

--suite

Comma separated list of strings

Compile and run all test suites specified. Must be specified by full path, either absolute or relative to the current directory.

--group

Comma separated list of strings

Test groups to run. See the Common Test Documentation.

--case

Comma separated list of strings

List of test cases to run. See the Common Test Documentation.

--spec

Comma separated list of strings

List of Test Specifications

--join_spec

Comma separated list of strings

Like --spec but merges all the specifications into one and does a single run.

--repeat

Integer

How often to repeat the tests

--duration

String (format: HHMMSS)

Max allowed duration of the test run

--until

String (format: HHMMSS)

Time until which to run the tests

--force_stop

true | false | skip_rest

Force termination on test timeout

--multiply_timetrap

Integer

Extends the timeout values for tests by a given multiplier value

--scale_timetrap

Boolean

Enables automatic timeout value scaling, when using code coverage or tracing

--abort_if_suite_is_missing

Boolean

Abort the test run if a test suite is missing (Default: true)

--sys_config

String

List of OTP application config files (like sys.config) that should be applied by Rebar3 before the test run.

--config

Comma separated list of strings

Config files to use when running tests. See the Common Test Documentation.

--allow_user_terms

Boolean

Allow user defined config values in config files. See the Common Test Documentation.

--decrypt_key

String

If the configuration file is encrypted, set the key to decrypt it

--decrypt_file

String

If the configuration file is encrypted, point to the file containing the key to decrypt it

--logdir

String

The directory in which test logs will be written. See the Common Test Documentation. Default: _build/test/logs

--logopts

Comma separated list of strings

Set common test logging options. See the Common Test Documentation. Default: _build/test/logs

--readable

Boolean

Adds test names with results on a per-test basis, and only displays common-test logs in the terminal on failing tests. Default: true

-v, --verbose

Boolean

Enable verbose output. Default: false

--verbosity

Integer

Set the level of Common Test verbosity

-c, --cover

Boolean

Generate cover data

--cover_export_name

String

Change the name of the code coverage file

--label

String

Set a test label

--basic_html

Boolean

show basic HTML

--stylesheet

String

CSS stylesheet to apply to HTML output

--create_priv_dir

auto_per_run | auto_per_tc | manual_per_tc

change the behaviour of the private (scratch) directories creation done by Common Test

--include

String

Additional directories containing include files. Option added for parity with ct_run, usually rebar3 should take care of include file paths

--name
--sname

String

Start a distributed node with a given name

--setcookie

String

Set a value for the distributed cookie

--compile_only

Boolean

Compile the project with the test configuration specified, but without running the tests

--reset/-r

none

Resets all cover data

--verbose/-v

none

Prints coverage analysis in the terminal.

--update-plt/-u

boolean

Enable updating the PLT. Default: true

true

--succ-typings/-s

boolean

Enable success typing analysis. Default: true

true

warnings

a list of dialyzer warnings

get_warnings

display warnings when altering a PLT file (boolean)

plt_apps

the strategy for determining the applications which are included in the PLT file, top_level_deps to include just the direct dependencies or all_deps to include all nested dependencies (the direct dependent applications are listed in applications and included_applications of their .app files.)

plt_extra_apps

a list of applications to include in the PLT file (the applications in base_plt_apps will already be in the list)

plt_location

the location of the PLT file, local to store in the profile's base directory (default) or a custom directory.

plt_prefix

the prefix to the PLT file, defaults to "rebar3"

base_plt_apps

a list of applications to include in the base PLT file

base_plt_location

the location of base PLT file, global to store in $HOME/.cache/rebar3 (default) or a custom directory

base_plt_prefix

the prefix to the base PLT file, defaults to "rebar3"

escript_main_app

atom

Name of the application to turn to an escript. Defaults to the top-level app if there is only one.

When using an umbrella repository (with multiple top-level apps), this value must be specified.

escript_name

string

Name of the generated escript, and default module name to boot (Module:main(_)).
Defaults to the value for escript_main_app

escript_incl_apps

list of atoms

List of applications to include in the escript archive aside from the main app and its dependencies (from the app file). Defaults to []

escript_emu_args

string

Escript emulator arguments (after %%! in escript declarations).

The string must begin with %%! and end with a line break. An example string would be "%%! +sbtu +A0\n".

The Default value is "%%! -escript main MainApp\n"

escript_shebang

string

Location of escript file to run. Defaults to "#!/usr/bin/env escript\n". The end of line marker must be included in the string.

escript_comment

string

Arbitrary comment to put into the generated escript. Must include a newline marker at the end.

Defaults to %%\n.

--cover/-c

Boolean

Generate cover data

--verbose/-v

Boolean

Verbose output

--app

Comma separated list of strings

List of applications to run tests for. Equivalent to EUnit's [{application, App}].

--suite

Comma separated list of strings

List of test suites to run. Equivalent to EUnit's [{module, Suite}].

--file/-f

Comma separated list of strings

List of files to run (such as test/my_tests.beam), equivalent to Eunit's [{file, File}].

$task

string

Task to print help for.

$namespace $task

string

Task within $namespace to print help for

--force/-f

none

Overwrite existing files.

help $template

none

Display all variables and arguments for each template

--base

none

Return the base path of the current profile.

--bin

none

Return the bin path of the current profile.

--ebin

none

Return all ebin paths of the current profile's applications.

--lib

none

Return the lib path of the current profile.

--priv

none

Return the priv path of the current profile.

--separator/-s

string

In case of multiple return paths, the separator character to use to join them.

--src

none

Return the src path of the current profile's applications.

--rel

none

Return the rel path of the current profile.

--config

string

Allows to load a config file, if any.

Defaults to the sys_config entry defined for relx if present.

--name / --sname

atom

Starts the node in network mode. Equivalent to erl's -name and -sname options.

--setcookie

string

Sets the cookie for a distributed node. Equivalent to erl's -setcookie option

--script

string

path to an escript to be evaluated before applications are started

--apps

string

Comma-separated list of application names to be booted.

Defaults to the apps in the relx release if present.

--start-clean

When specified, no apps are booted by the shell; useful to override release or shell tuple configurations in rebar.config

--relname / -r

atom

If multiple releases are present, specify which one to pick

--relvsn / -v

string

If multiple releases are present, specify which version to use

$dependency

string

Dependencies to upgrade (comma-separated).
If no dependency is mentioned, all dependencies are upgraded.