提供便利性，用於建立、載入和操作 Mix 任務。

Mix 任務可以透過在模組中定義 use Mix.Task 來定義，其名稱以 Mix.Tasks. 開頭，且定義了 run/1 函式。通常，任務模組會存在於 lib/mix/tasks/ 目錄中，且其檔案名稱使用點分隔符號，而非底線（例如 deps.clean.ex） - 儘管最終檔案名稱並無關聯。

例如

# lib/mix/tasks/echo.ex
defmodule Mix.Tasks.Echo do
  @moduledoc "Printed when the user requests `mix help echo`"
  @shortdoc "Echoes arguments"

  use Mix.Task

  @impl Mix.Task
  def run(args) do
    Mix.shell().info(Enum.join(args, " "))
  end
end

指令名稱會對應到模組名稱中，緊接在 Mix.Tasks. 之後的區段。例如，模組名稱為 Mix.Tasks.Deps.Clean 會對應到指令名稱 deps.clean。

根據使用者的終端機，run/1 函式將會收到傳遞的所有命令列引數清單。

例如，如果檢查上述 echo 任務中的 args，你可能會看到類似這樣的內容

$ mix echo 'A and B' C --test
["A and B", "C", "--test"]

use Mix.Task

當你 use Mix.Task 時，Mix.Task 模組將會設定 @behaviour Mix.Task，並為下方區段中記載的模組屬性定義預設值。

模組屬性

你可以透過設定模組屬性來控制 Mix 任務的某些行為。本區段記載了可用的屬性。

@shortdoc

如果你希望在 mix help 上公開顯示任務，請定義 @shortdoc 屬性。如果你不希望透過 mix help 列出你的任務，請省略此屬性。

@moduledoc

屬性 @moduledoc 可以覆寫 @shortdoc。如果整個模組的說明文件以 @moduledoc false 隱藏，則任務將不會顯示在 mix help 中。

@requirements

如果任務有需求，可以使用屬性 @requirements 列出。需求是此任務需要執行的其他 Mix 任務。例如

@requirements ["app.config"]

任務通常會依賴下列任務之一

• "loadpaths" - 確保相依性可用且已編譯。如果您要發布任務作為供其他人使用的函式庫的一部分，而且您的任務不需要以任何方式與使用者程式碼互動，則這是建議的需求

• "app.config" - 另外編譯並載入目前專案的執行時期設定。如果您要建立一個任務在應用程式中使用，或作為函式庫的一部分，而且必須呼叫或與使用者程式碼互動，則這是建議的最低需求

• "app.start" - 另外啟動目前專案及其相依性的監督樹

@recursive

如果您希望任務在傘狀專案中的每個傘狀子專案執行，請設定 @recursive true。

@preferred_cli_env

設定此任務偏好的 Mix 環境。例如，如果您的任務是要用於測試，則可以設定

@preferred_cli_env :test

文件

使用者可以透過執行 mix help my_task 來閱讀公開 Mix 任務的文件。將會顯示的文件是任務模組的 @moduledoc。