1REBAR3(1) General Commands Manual REBAR3(1)
2
6 rebar3 - tool for working with Erlang projects
7
10 rebar3 --version
11 rebar3 help
13 rebar3 command [options] ...
15
18 Rebar3 is an Erlang tool that makes it easy to create, develop, and
19 release Erlang libraries, applications, and systems in a repeatable
20 manner.
21 Full documentation at http://www.rebar3.org/
23
26 For the full command list, see the COMMANDS section.
27 With rebar3 help <task>, commands and plugins will display their own
30 help information.
31 compile
34 Compile the current project
35 new (help [template])|template
38 Show information about templates or use one
39 update Fetch the newest version of the Hex index
42 do command[,command,...]
45 Run one or more commands in a sequence
46 shell Start the current project in a REPL. You can then use
49 r3:do(task) to call it on the project without dropping the cur‐
50 rent state.
51
54 as Higher order provider for running multiple tasks in a sequence
55 as a certain profiles.
56 clean [-a|--all] [-p|--profile]
58 Remove compiled beam files from apps.
59 --all: Clean all apps include deps
61 --profile: Clean under profile. Equivalent to `rebar3 as <pro‐
63 file> clean`
64 compile [-d|--deps_only]
66 Compile apps .app.src and .erl files.
67 --deps_only: Only compile dependencies, no project apps will be
69 built.
70 cover [-r|--reset] [-v|--verbose] [-m|--min_coverage]
72 Perform coverage analysis.
73 --reset: Reset all coverdata.
75 --verbose: Print coverage analysis.
77 --min_coverage: Mandate a coverage percentage required to suc‐
79 ceed (0..100)
80 ct [--dir] [--suite] [--group] [--case] [--label] [--config] [--spec]
82 [--join_specs] [--allow_user_terms] [--logdir] [--logopts] [--ver‐
83 bosity] [-c|--cover] [--cover_export_name] [--repeat] [--duration]
84 [--until] [--force_stop] [--basic_html] [--stylesheet] [--decrypt_key]
85 [--decrypt_file] [--abort_if_missing_suites] [--multiply_timetraps]
86 [--scale_timetraps] [--create_priv_dir] [--include] [--readable]
87 [-v|--verbose] [--name] [--sname] [--setcookie] [--sys_config] [--com‐
88 pile_only] [--retry]
89 Run Common Tests.
90 --dir: List of additional directories containing test suites
92 --suite: List of test suites to run
94 --group: List of test groups to run
96 --case: List of test cases to run
98 --label: Test label
100 --config: List of config files
102 --spec: List of test specifications
104 --join_specs: Merge all test specifications and perform a single
106 test run
107 --allow_user_terms: Allow user defined config values in config
109 files
110 --logdir: Log folder
112 --logopts: Options for common test logging
114 --verbosity: Verbosity
116 --cover: Generate cover data
118 --cover_export_name: Base name of the coverdata file to write
120 --repeat: How often to repeat tests
122 --duration: Max runtime (format: HHMMSS)
124 --until: Run until (format: HHMMSS)
126 --force_stop: Force stop on test timeout (true | false |
128 skip_rest)
129 --basic_html: Show basic HTML
131 --stylesheet: CSS stylesheet to apply to html output
133 --decrypt_key: Path to key for decrypting config
135 --decrypt_file: Path to file containing key for decrypting con‐
137 fig
138 --abort_if_missing_suites: Abort if suites are missing
140 --multiply_timetraps:
142 --scale_timetraps: Scale timetraps
144 --create_priv_dir: Create priv dir (auto_per_run | auto_per_tc |
146 manual_per_tc)
147 --include: Directories containing additional include files
149 --readable: Shows test case names and only displays logs to
151 shell on failures (true | compact | false)
152 --verbose: Verbose output
154 --name: Gives a long name to the node
156 --sname: Gives a short name to the node
158 --setcookie: Sets the cookie if the node is distributed
160 --sys_config: List of application config files
162 --compile_only: Compile modules in the project with the test
164 configuration but do not run the tests
165 --retry: Experimental feature. If any specification for previ‐
167 ously failing test is found, runs them.
168 deps List dependencies
170 dialyzer [-u|--update-plt] [-s|--succ-typings]
172 Run the Dialyzer analyzer on the project.
173 --update-plt: Enable updating the PLT. Default: true
175 --succ-typings: Enable success typing analysis. Default: true
177 do Higher order provider for running multiple tasks in a sequence.
179 edoc Generate documentation using edoc.
181 escriptize
183 Generate escript archive.
184 eunit [--app] [--application] [-c|--cover] [--cover_export_name]
186 [-d|--dir] [-f|--file] [-m|--module] [-s|--suite] [-v|--verbose]
187 [--name] [--sname] [--setcookie]
188 Run EUnit Tests.
189 --app: Comma separated list of application test suites to run.
191 Equivalent to `[{application, App}]`.
192 --application: Comma separated list of application test suites
194 to run. Equivalent to `[{application, App}]`.
195 --cover: Generate cover data. Defaults to false.
197 --cover_export_name: Base name of the coverdata file to write
199 --dir: Comma separated list of dirs to load tests from. Equiva‐
201 lent to `[{dir, Dir}]`.
202 --file: Comma separated list of files to load tests from. Equiv‐
204 alent to `[{file, File}]`.
205 --module: Comma separated list of modules to load tests from.
207 Equivalent to `[{module, Module}]`.
208 --suite: Comma separated list of modules to load tests from.
210 Equivalent to `[{module, Module}]`.
211 --verbose: Verbose output. Defaults to false.
213 --name: Gives a long name to the node
215 --sname: Gives a short name to the node
217 --setcookie: Sets the cookie if the node is distributed
219 get-deps
221 Fetch dependencies.
222 help Display a list of tasks or help for a given task or subtask.
224 new [-f|--force]
226 Create new project from templates.
227 --force: overwrite existing files
229 path [--app] [--base] [--bin] [--ebin] [--lib] [--priv] [-s|--separa‐
231 tor] [--src] [--rel]
232 Print paths to build dirs in current profile.
233 --app: Comma separated list of applications to return paths for.
235 --base: Return the `base' path of the current profile.
237 --bin: Return the `bin' path of the current profile.
239 --ebin: Return all `ebin' paths of the current profile's appli‐
241 cations.
242 --lib: Return the `lib' path of the current profile.
244 --priv: Return the `priv' path of the current profile's applica‐
246 tions.
247 --separator: In case of multiple return paths, the separator
249 character to use to join them.
250 --src: Return the `src' path of the current profile's applica‐
252 tions.
253 --rel: Return the `rel' path of the current profile.
255 pkgs List information for a package.
257 release [-n|--relname] [-v|--relvsn] [-g|--goal] [-u|--upfrom]
259 [-o|--output-dir] [-h|--help] [-l|--lib-dir] [-p|--path] [--default-
260 libs] [-V|--verbose] [-d|--dev-mode] [-i|--include-erts] [-a|--over‐
261 ride] [-c|--config] [--overlay_vars] [--vm_args] [--sys_config] [--sys‐
262 tem_libs] [--version] [-r|--root]
263 Build release of project.
264 --relname: Specify the name for the release that will be gener‐
266 ated
267 --relvsn: Specify the version for the release
269 --goal: Specify a target constraint on the system. These are
271 usually the OTP
272 --upfrom: Only valid with relup target, specify the release to
274 upgrade from
275 --output-dir: The output directory for the release. This is `./`
277 by default.
278 --help: Print usage
280 --lib-dir: Additional dir that should be searched for OTP Apps
282 --path: Additional dir to add to the code path
284 --default-libs: Whether to use the default system added lib dirs
286 (means you must add them all manually). Default is true
287 --verbose: Verbosity level, maybe between 0 and 3
289 --dev-mode: Symlink the applications and configuration into the
291 release instead of copying
292 --include-erts: If true include a copy of erts used to build
294 with, if a path include erts at that path. If false, do not
295 include erts
296 --override: Provide an app name and a directory to override in
298 the form <appname>:<app directory>
299 --config: The path to a config file
301 --overlay_vars: Path to a file of overlay variables
303 --vm_args: Path to a file to use for vm.args
305 --sys_config: Path to a file to use for sys.config
307 --system_libs: Path to dir of Erlang system libs
309 --version: Print relx version
311 --root: The project root directory
313 relup [-n|--relname] [-v|--relvsn] [-g|--goal] [-u|--upfrom] [-o|--out‐
315 put-dir] [-h|--help] [-l|--lib-dir] [-p|--path] [--default-libs]
316 [-V|--verbose] [-d|--dev-mode] [-i|--include-erts] [-a|--override]
317 [-c|--config] [--overlay_vars] [--vm_args] [--sys_config] [--sys‐
318 tem_libs] [--version] [-r|--root]
319 Create relup of releases.
320 --relname: Specify the name for the release that will be gener‐
322 ated
323 --relvsn: Specify the version for the release
325 --goal: Specify a target constraint on the system. These are
327 usually the OTP
328 --upfrom: Only valid with relup target, specify the release to
330 upgrade from
331 --output-dir: The output directory for the release. This is `./`
333 by default.
334 --help: Print usage
336 --lib-dir: Additional dir that should be searched for OTP Apps
338 --path: Additional dir to add to the code path
340 --default-libs: Whether to use the default system added lib dirs
342 (means you must add them all manually). Default is true
343 --verbose: Verbosity level, maybe between 0 and 3
345 --dev-mode: Symlink the applications and configuration into the
347 release instead of copying
348 --include-erts: If true include a copy of erts used to build
350 with, if a path include erts at that path. If false, do not
351 include erts
352 --override: Provide an app name and a directory to override in
354 the form <appname>:<app directory>
355 --config: The path to a config file
357 --overlay_vars: Path to a file of overlay variables
359 --vm_args: Path to a file to use for vm.args
361 --sys_config: Path to a file to use for sys.config
363 --system_libs: Path to dir of Erlang system libs
365 --version: Print relx version
367 --root: The project root directory
369 report Provide a crash report to be sent to the rebar3 issues page.
371 shell [--config] [--name] [--sname] [--setcookie] [--script] [--apps]
373 [--start-clean] [--user_drv_args]
374 Run shell with project apps and deps in path.
375 --config: Path to the config file to use. Defaults to {shell,
377 [{config, File}]} and then the relx sys.config file if not spec‐
378 ified.
379 --name: Gives a long name to the node.
381 --sname: Gives a short name to the node.
383 --setcookie: Sets the cookie if the node is distributed.
385 --script: Path to an escript file to run before starting the
387 project apps. Defaults to rebar.config {shell, [{script_file,
388 File}]} if not specified.
389 --apps: A list of apps to boot before starting the shell. (E.g.
391 --apps app1,app2,app3) Defaults to rebar.config {shell, [{apps,
392 Apps}]} or relx apps if not specified.
393 --start-clean: Cancel any applications in the 'apps' list or
395 release.
396 --user_drv_args: Arguments passed to user_drv start function for
398 creating custom shells.
399 tar [-n|--relname] [-v|--relvsn] [-g|--goal] [-u|--upfrom] [-o|--out‐
401 put-dir] [-h|--help] [-l|--lib-dir] [-p|--path] [--default-libs]
402 [-V|--verbose] [-d|--dev-mode] [-i|--include-erts] [-a|--override]
403 [-c|--config] [--overlay_vars] [--vm_args] [--sys_config] [--sys‐
404 tem_libs] [--version] [-r|--root]
405 Tar archive of release built of project.
406 --relname: Specify the name for the release that will be gener‐
408 ated
409 --relvsn: Specify the version for the release
411 --goal: Specify a target constraint on the system. These are
413 usually the OTP
414 --upfrom: Only valid with relup target, specify the release to
416 upgrade from
417 --output-dir: The output directory for the release. This is `./`
419 by default.
420 --help: Print usage
422 --lib-dir: Additional dir that should be searched for OTP Apps
424 --path: Additional dir to add to the code path
426 --default-libs: Whether to use the default system added lib dirs
428 (means you must add them all manually). Default is true
429 --verbose: Verbosity level, maybe between 0 and 3
431 --dev-mode: Symlink the applications and configuration into the
433 release instead of copying
434 --include-erts: If true include a copy of erts used to build
436 with, if a path include erts at that path. If false, do not
437 include erts
438 --override: Provide an app name and a directory to override in
440 the form <appname>:<app directory>
441 --config: The path to a config file
443 --overlay_vars: Path to a file of overlay variables
445 --vm_args: Path to a file to use for vm.args
447 --sys_config: Path to a file to use for sys.config
449 --system_libs: Path to dir of Erlang system libs
451 --version: Print relx version
453 --root: The project root directory
455 tree [-v|--verbose]
457 Print dependency tree.
458 --verbose: Print repo and branch/tag/ref for git and hg deps
460 unlock Unlock dependencies.
462 update Update package index.
464 upgrade
466 Upgrade dependencies.
467 version
469 Print version for rebar and current Erlang.
470 xref Run cross reference analysis.
472
475 Environment variables allow overall rebar3 control across command
476 boundaries.
477 REBAR_PROFILE
480 Choose a default profile. Defaults to default
481 HEX_CDN
484 Pick an alternative hex mirror.
485 REBAR_CACHE_DIR
488 Location of the directory for local cache. Defaults to hex.pm.
489 QUIET Only display errors.
492 DEBUG Display debug information.
495 REBAR_COLOR=high|low
498 How much color to show in the terminal. Defaults to high.
499 REBAR_CONFIG
502 Name of rebar configuration files. Defaults to rebar.config
503 REBAR_GIT_CLONE_OPTIONS
506 Arguments to add after each git clone operation. For example,
507 the value --reference ~/.cache/repos.reference allows to create
508 a cache of all fetched repositories across builds
509
512 See http://www.rebar3.org/v3.0/docs/configuration
513Erlang November 2018 REBAR3(1)