快速入門
Rebar3 是 Erlang 社群中的標準建置工具。它整合了許多 Erlang 附帶的其他工具以及一些開源工具,並使它們在統一的專案結構下工作。
安裝 Erlang
Rebar3 需要您的系統中已安裝 Erlang 才能運行。如果 Erlang 可以運行,Rebar3 也應該可以運行。
請參閱 Adopting Erlang 的 安裝 Erlang/OTP 章節,了解如何在 Windows、MacOS、Linux 和 FreeBSD 上安裝 Erlang 的詳細步驟。
從 Rebar3 escript 安裝
下載最新的穩定版本 作為可執行的 escript。雖然 Rebar3 的腳本版本是可移植的,可以在任何地方使用,但不建議將其保存在專案的儲存庫中,而是建議將其全局安裝,供整個系統使用。無論您安裝了哪個最新的 Erlang 版本,Rebar3 都應該與之完全相容。
然而,escript 的一個缺點是它比一般的 Erlang 程式慢一些。我們建議安裝 Rebar3 的完整編譯版本,Rebar3 本身可以為您完成此操作
$ ./rebar3 local install
===> Extracting rebar3 libs to ~/.cache/rebar3/lib...
===> Writing rebar3 run script ~/.cache/rebar3/bin/rebar3...
===> Add to $PATH for use: export PATH=$PATH:~/.cache/rebar3/bin
請務必遵循指令輸出的指示,並將可執行檔添加到系統的 $PATH
中,例如調用 export PATH=$PATH:~/.cache/rebar3/bin
。然後,您可以刪除用於運行 local install
的 rebar3
escript。
當 rebar3
的新穩定版本可用時,您只需運行 rebar3 local upgrade
,新版本就會以相同的方式獲取和安裝
$ rebar3 local upgrade
===> Extracting rebar3 libs to ~/.cache/rebar3/lib...
===> Writing rebar3 run script ~/.cache/rebar3/bin/rebar3...
===> Add to $PATH for use: export PATH=$PATH:~/.cache/rebar3/bin
Windows
想要在 PowerShell 或 cmd.exe
(而不是終端模擬器)中使用程式碼的 Windows 用戶必須確保添加了 rebar3.cmd
檔案
@echo off
setlocal
set rebarscript=%~f0
escript.exe "%rebarscript:.cmd=%" %*
然後將儲存檔案的目錄添加到系統 PATH
中。
如果您想更改預設路徑 (C:\Users\<user>
),您可以設定一個指向您喜歡的目錄的 REBAR_CACHE_DIR
環境變數。
從原始碼安裝
rebar3
專案的儲存庫託管在 GitHub 上,並附帶一個用於從原始碼建置的 bootstrap
腳本。這種方式可能減少 Windows 使用者遇到的問題,因為從原始碼建置將會產生在 cmd.exe
和 PowerShell 環境中良好運作所需的包裝器腳本
$ git clone https://github.com/erlang/rebar3.git
$ cd rebar3
$ ./bootstrap
這將在 rebar3
目錄的頂層編譯一個 rebar3
escript,然後您可以將其全局安裝
$ ./rebar3 local install
請注意,如果您計劃在同一台機器上使用多個 Erlang 版本,您需要使用其中最舊的版本建置 Rebar3。任何時候都支援三個最新的 Erlang 主要版本:如果最新版本是 OTP-24,則支援使用 OTP-22 等舊版本進行建置,並產生一個可與後續版本一起使用的可執行檔。
建立新專案
Rebar3 提供了範本,可確保您的 Erlang 專案符合標準的 OTP 結構
$ rebar3 new umbrella myproj
===> Writing apps/myproj/src/myproj_app.erl
===> Writing apps/myproj/src/myproj_sup.erl
===> Writing apps/myproj/src/myproj.app.src
===> Writing rebar.config
===> Writing config/sys.config
===> Writing config/vm.args
===> Writing .gitignore
===> Writing LICENSE
===> Writing README.md
OTP 結構是 Rebar3 預期的基本契約的一部分;遵循它將確保比其他方式更好的體驗。
您可以參閱 基本用法 以了解更多關於如何使用 rebar3
的資訊,並接著閱讀 工作流程 以了解更廣泛的用法。