API Reference Mix v1.11.2



Mix is a build tool that provides tasks for creating, compiling, and testing Elixir projects, managing its dependencies, and more.

Mix.Config deprecated

A simple configuration API and functions for managing config files.

Conveniences for working with paths and generating content.

Defines and manipulates Mix projects.

Defines the release structure and convenience for assembling releases.

This module provides helper functions and defines the behaviour required by any source code manager (SCM) used by Mix.

Defines Mix.Shell contract.

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.

Provides conveniences for creating, loading, and manipulating Mix tasks.

This module defines the behaviour for a Mix task that does compilation.

Diagnostic information such as a warning or compilation error.

Mix Tasks

Loads and configures all registered apps.

Starts all registered apps.

Prints the application tree.

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.

The main entry point to compile 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.

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.

Checks and loads all dependencies along the way.

Extension point for precompiling dependencies.

Prints the dependency tree.

Unlocks the given dependencies.

Updates the given dependencies.

Executes the tasks separated by comma.

Lists all installed escripts.

Builds an escript for the project.

Installs an escript locally.

Uninstalls local escripts

Formats the given files and patterns.

Lists all tasks and aliases or prints the documentation for a given task or alias.

A task that simply instructs users to run 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 cprof tool.

Profiles the given file or expression using Erlang's eprof tool.

Profiles the given file or expression using Erlang's fprof tool.

Assembles a self-contained release for the current project

Generates sample files for releases.

Starts the current application and runs code.

Runs the tests for a project.

Build report from exported test coverage.

Prints cross reference information between modules.