命令

每个 Rebar3 命令的用法。

每个命令代表一个任务，它运行一个或多个提供者来完成任务。

作为

高阶任务，它采用配置文件名称和要在该配置文件下运行的任务列表。

编译

在确保所有依赖项都可用并获取它们（如果它们不可用）之后，compile 将编译所需的依赖项以及项目的应用程序.app.src和.erl文件。

干净的

从应用程序中删除已编译的 BEAM 文件。

默认情况下，该clean命令会删除顶级应用程序的 BEAM 文件。它在尊重配置文件的同时这样做，这意味着“rebar3 clean”只会清理默认配置文件，而“rebar3 as test clean”只会清理测试配置文件。

ct

test/为目录下的项目运行通用测试。

Erlang 文档中描述的大多数通用测试选项ct_run都可用。一些常见的描述如下：

在test配置文件中运行。

覆盖

对 Common Test 或 Eunit 测试套件调用的模块执行覆盖分析。在您的钢筋配置文件中或单独使用封面标志时，请调用AS AS rebar3 do ct, cover，或在选项中rebar3 do eunit, cover与两者的组合。rebar3 do eunit, ct, cover``{cover_enabled, true}

生成 HTML 报告。

{cover_excl_mods, [Modules]}通过添加到配置文件中，可以将特定模块从代码覆盖率中列入黑名单。{cover_excl_apps, [AppNames]}通过添加到配置文件可以将特定应用程序列入黑名单。

部门

列出依赖关系，它们是源依赖还是包依赖，以及它们是否被锁定。那些被锁定但与锁定文件不匹配的文件后跟一个星号 ( *)。

做

用于按顺序运行多个任务的高阶提供程序，以逗号分隔。示例：rebar3 do a, b, c。

透析器

构建并更新一个合适的 PLT（Persistent Lookup Table），并使用它对当前项目进行成功类型分析。

有关抑制警告的说明，请阅读 Dialyzer 文档的请求或抑制源文件中的警告部分。

PLT 文件被命名为<prefix>_<otp_release>_plt; 基础 PLT 是包含项目 PLT 经常需要的核心应用程序的 PLT。每个 OTP 版本创建一个基本 PLT，并存储在base_plt_location. 然后使用基础 PLT 构建项目 PLT。

可以将以下（可选）配置添加到rebar.configproplist中的选项中：dialyzer

教育部

使用 doc 生成文档。

在docs配置文件中运行。

描述

生成包含项目及其依赖项的 BEAM 文件的escript可执行文件。

要覆盖 escript 的默认模块名称（预计与 相同escript_name），添加-escript main Module到escript_emu_args.

示例 escript 配置来自relx：

{escript_emu_args, "%%! +sbtu +A0 -noinput\n"}.
{escript_incl_apps, [getopt, erlware_commons, bbmustache, providers, relx]}.

二郎

复制

他去

在项目应用程序上运行 EUnit 测试。

有关更多详细信息，请参阅EUnit。

在test配置文件中运行。

获取部门

🚧 不需要

与 Rebar 2 不同，获取依赖项不需要此命令。compile 命令将导致依赖项被获取，然后如果它们还没有被构建。如果您有一个特定的用例需要从编译中提取依赖项，则此命令很有用。

获取项目依赖项。

帮助

显示给定任务或子任务的任务或帮助列表。

新的

从模板创建一个新项目。通过不提供参数来查看可用模板的列表。

小路

打印当前配置文件中构建目录的路径。

发布

构建项目的发布。呼吁rebar3 help release争论。

重复

rebar3 release从已经通过调用而不清除_build目录构建的两个版本创建一个 relup 。呼吁rebar3 help relup争论。

报告

生成上下文数据以包含在错误报告中。

壳

在路径中运行带有项目应用程序和 deps 的 shell。仅用于开发用途；使用发布进行生产。

使用此命令启动的 shell 有一个正在运行的代理，它允许动态运行 Rebar3 命令，例如r3:compile()or r3:upgrade()，并自动重新加载新模块。可以通过调用来访问特定的命名空间r3:do(Namespace, Command)。不能将任何参数传递给这些命令。

柏油

构建项目构建的发布的压缩 tar 存档。呼吁rebar3 help tar争论。

树

打印项目的依赖关系和传递依赖关系树。

锁

获取要添加到rebar.lock文件中的未构建依赖项。它们刚刚被下载，但它们的构建脚本都不应该运行。尽管对于 pre/post 钩子和 dep 插件来说，这不一定是正确的。

开锁

解锁依赖项。指定以逗号分隔的依赖项列表以解锁并重新生成rebar.lock文件，或者-a,--all将它们全部解锁并删除rebar.lock文件。

当一个或多个依赖项已从 中取出rebar.config但仍保留在锁定文件中时，应使用此命令。

更新

更新包索引。

升级

获取当前的依赖规范rebar.config并获取满足它们的最新版本，同时相应地更新锁定文件。

版本

打印 rebar3 和当前 Erlang 的版本。

外部参照

运行交叉引用分析。