Mix Command Reference

From Elixir Wiki
Jump to navigation Jump to search

Mix Command Reference[edit]

Introduction[edit]

File:Mix Logo.png

This page provides a comprehensive reference for the various commands available in the Mix build tool of the Elixir programming language. Mix is a powerful command-line tool that facilitates development, compilation, testing, and deployment of Elixir projects.

Command List[edit]

Below is a list of Mix commands along with a brief description of each:

  • mix new
Create a new Elixir project.
  • mix compile
Compile Elixir source code.
  • mix test
Run tests for the current project.
  • mix run
Execute an Elixir script.
  • mix clean
Remove compiled files and artifacts.
  • mix deps.get
Fetch project dependencies.
  • mix deps.compile
Compile project dependencies.
  • mix docs
Generate project documentation.
  • mix format
Format Elixir source code.
  • mix release
Create a standalone release of the project.
  • mix escript.build
Build an executable script.
  • mix help
Displays help information about Mix commands.

Command Usage[edit]

To use a Mix command, simply open your terminal or command prompt, navigate to the root directory of your Elixir project, and run the desired command using the following syntax:

``` mix <command> ```

For example, to compile your Elixir source code, you would run:

``` mix compile ```

Conclusion[edit]

Mix is an essential tool in the Elixir ecosystem, offering a wide range of commands to streamline and enhance the development process. This reference guide should help you become familiar with the available Mix commands and their usage.

For more in-depth information on each command, refer to the respective articles on the Elixir wiki.