Mix v1.2.6 API Reference
Modules
Mix is a build tool that provides tasks for creating, compiling, and testing Elixir projects, managing its dependencies, and more
Module responsible for managing archives
Module for defining, reading and merging app configurations
Conveniences for working with paths and generating content
Defines and manipulate Mix projects
This module provides helper functions and defines the behaviour required by any SCM used by Mix
This is Mix’s default shell
Mix shell that uses the current process mailbox for communication
This is Mix’s default shell when the MIX_QUIET
environment
variable is set
A simple module that provides conveniences for creating, loading and manipulating tasks
Starts all registered apps
Lists all installed archives
Builds an archive according to the specification of the Erlang Archive Format
Checks all archives are available
Installs an archive locally
Uninstalls local archives
Deletes generated application files
Executes the given command
A meta task that compiles source files
Writes an .app file
Compiles Elixir source files
Compiles Erlang source files
Compiles Leex source files
Consolidates all protocols in all paths
Compiles Yecc source files
Lists all dependencies and their status
Checks if all dependencies are valid and if not, abort. Prints the invalid dependencies’ status before aborting
Deletes the given dependencies’ files, including build artifacts and fetched sources
Compiles dependencies
Gets all out of date dependencies, i.e. dependencies that are not available or have an invalid lock
Loads the available dependencies paths
Extension point for precompiling dependencies
Unlocks the given dependencies
Updates the given dependencies
Executes the tasks separated by comma
Builds an escript for the project
Lists all tasks or prints the documentation for a given task
A task that is simply meant to redirect users to iex -S mix
Loads and persists the given configuration
Loads the application and its dependencies paths
Lists local tasks
Installs Hex locally
Public keys are used by Mix to install packages like Rebar and Hex
Fetches a copy of rebar
or rebar3
from the given path or url
Creates a new Elixir project. It expects the path of the project as argument
Profiles the given file or expression using Erlang’s fprof
tool
Runs the given file or expression in the context of the application
Runs the tests for a project
Utilities used throughout Mix and tasks