Mix
▼
Project version
v1.18.3
v1.18.2
v1.18.1
v1.18.0
v1.18.0-rc.0
v1.17.3
v1.17.2
v1.17.1
v1.17.0
v1.17.0-rc.1
v1.17.0-rc.0
v1.16.3
v1.16.2
v1.16.1
v1.16.0
v1.16.0-rc.1
v1.16.0-rc.0
v1.15.8
v1.15.7
v1.15.6
v1.15.5
v1.15.4
v1.15.3
v1.15.2
v1.15.1
v1.15.0
v1.15.0-rc.2
v1.15.0-rc.1
v1.15.0-rc.0
v1.14.5
v1.14.4
v1.14.3
v1.14.2
v1.14.1
v1.14.0
v1.14.0-rc.1
v1.14.0-rc.0
v1.13.4
v1.13.3
v1.13.2
v1.13.1
v1.13.0
v1.13.0-rc.1
v1.13.0-rc.0
v1.12.3
v1.12.2
v1.12.1
v1.12.0
v1.12.0-rc.1
v1.12.0-rc.0
v1.11.4
v1.11.3
v1.11.2
v1.11.1
v1.11.0
v1.11.0-rc.0
v1.10.4
v1.10.3
v1.10.2
v1.10.1
v1.10.0
v1.10.0-rc.0
v1.9.4
v1.9.3
v1.9.2
v1.9.1
v1.9.0
v1.9.0-rc.0
v1.8.2
v1.8.1
v1.8.0
v1.8.0-rc.1
v1.8.0-rc.0
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.7.0-rc.1
v1.7.0-rc.0
v1.6.6
v1.6.5
v1.6.4
v1.6.3
v1.6.2
v1.6.1
v1.6.0
v1.6.0-rc.1
v1.6.0-rc.0
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.5.0-rc.2
v1.5.0-rc.1
v1.5.0-rc.0
v1.4.5
v1.4.4
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.4.0-rc.1
v1.4.0-rc.0
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.3.0-rc.1
v1.3.0-rc.0
v1.2.6
v1.2.5
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.2.0-rc.1
v1.2.0-rc.0
v1.1.1
v1.1.0
v1.1.0-rc.0
v1.0.5
v1.0.4
Pages
Modules
Mix
Tasks
API Reference
Modules
Mix Tasks
Mix
Sections
Mix.Project
Mix.Task
Dependencies
Environments
Targets
Configuration
Aliases
Environment variables
SSL certificates
Summary
Functions
compilers/0
debug/1
debug?/0
ensure_application!/1
env/0
env/1
install/2
install_project_dir/0
installed?/0
path_for/1
raise/1
raise/2
shell/0
shell/1
target/0
target/1
Mix.Generator
Summary
Functions
copy_file/3
copy_template/4
create_directory/2
create_file/3
embed_template/2
embed_text/2
overwrite?/1
overwrite?/2
Mix.Project
Sections
Configuration
CLI configuration
Erlang projects
Invoking this module
Summary
Functions
app_path/1
apps_paths/1
build_path/1
build_structure/2
clear_deps_cache/0
compile_path/1
config/0
config_files/0
config_mtime/0
consolidation_path/1
deps_apps/0
deps_path/1
deps_paths/1
deps_scms/1
deps_tree/1
ensure_structure/2
get/0
get!/0
in_project/4
load_paths/1
manifest_path/1
parent_umbrella_project_file/0
project_file/0
umbrella?/1
with_build_lock/2
Mix.Release
Summary
Types
application/0
mode/0
t/0
Functions
%Mix.Release{}
copy_app/2
copy_ebin/3
copy_erts/1
make_boot_script/4
make_cookie/2
make_start_erl/2
make_sys_config/3
rel_templates_path/2
strip_beam/2
Mix.SCM
Summary
Types
opts/0
t/0
Callbacks
accepts_options/2
checked_out?/1
checkout/1
equal?/2
fetchable?/0
format/1
format_lock/1
lock_status/1
managers/1
update/1
Functions
append/1
available/0
delete/1
prepend/1
Mix.Shell
Summary
Callbacks
cmd/1
cmd/2
error/1
info/1
print_app/0
prompt/1
yes?/1
yes?/2
Functions
cmd/3
printable_app_name/0
Mix.Shell.IO
Summary
Functions
cmd/2
error/1
info/1
print_app/0
prompt/1
yes?/2
Mix.Shell.Process
Sections
Examples
Summary
Functions
cmd/2
error/1
flush/1
info/1
print_app/0
prompt/1
yes?/2
Mix.Shell.Quiet
Summary
Functions
cmd/2
error/1
info/1
print_app/0
prompt/1
yes?/2
Mix.Task
Sections
Module attributes
Documentation
Summary
Types
task_module/0
task_name/0
Callbacks
run/1
Functions
alias?/1
all_modules/0
clear/0
get/1
get!/1
load_all/0
load_tasks/1
moduledoc/1
preferred_cli_env/1
recursing?/0
recursive/1
reenable/1
requirements/1
rerun/2
run/2
run_in_apps/3
shortdoc/1
task?/1
task_name/1
Mix.Task.Compiler
Sections
Listening to compilation
Summary
Types
status/0
Callbacks
clean/0
diagnostics/0
manifests/0
run/1
Functions
after_compiler/2
compilers/1
diagnostics/1
manifests/1
Mix.Task.Compiler.Diagnostic
Summary
Types
severity/0
t/0
Exceptions
Mix.ElixirVersionError
Mix.Error
Mix.InvalidTaskError
Mix.NoProjectError
Mix.NoTaskError
mix app.config
Sections
Command line options
mix app.start
Sections
Configuration
Command line options
mix app.tree
Sections
Command line options
mix archive
mix archive.build
Sections
Command line options
mix archive.check
mix archive.install
Sections
Command line options
mix archive.uninstall
Sections
Command line options
mix clean
Sections
Command line options
mix cmd
Sections
Command line options
Zombie operating system processes
mix compile
Sections
Configuration
Compilers
Command line options
Summary
Functions
compilers/1
manifests/0
mix compile.app
Sections
Command line options
Configuration
Phases
mix compile.elixir
Sections
@external_resource
__mix_recompile__?/0
Command line options
Configuration
mix compile.erlang
Sections
Command line options
Configuration
mix compile.leex
Sections
Command line options
Configuration
mix compile.protocols
Sections
Consolidation
Summary
Functions
consolidated?/0
mix compile.yecc
Sections
Command line options
Configuration
mix deps
Sections
Options
Deps task
mix deps.clean
mix deps.compile
Sections
Command line options
mix deps.get
Sections
Command line options
mix deps.loadpaths
Sections
Configuration
Command line options
mix deps.precompile
mix deps.tree
Sections
Command line options
Examples
mix deps.unlock
mix deps.update
Sections
mix deps.unlock + mix deps.get
Command line options
mix do
Sections
Examples
Command line options
mix escript
mix escript.build
Sections
Command line options
Configuration
Example
mix escript.install
Sections
Command line options
mix escript.uninstall
Sections
Command line options
mix eval
Sections
Command-line options
mix format
Sections
Formatting options
Task-specific options
When to format code
Plugins
Importing dependencies configuration
Summary
Callbacks
features/1
format/2
Functions
formatter_for_file/2
mix help
Sections
Arguments
Colors
mix iex
mix loadconfig
mix loadpaths
Sections
Configuration
Command line options
mix local
mix local.hex
Sections
Command line options
Mirrors
mix local.public_keys
Sections
Command line options
mix local.rebar
Sections
Command line options
Mirrors
mix new
Sections
Examples
Summary
Functions
reserved_application_names/0
mix profile.cprof
Sections
Command line options
Profile output
Caveats
Summary
Functions
profile/2
mix profile.eprof
Sections
Command line options
Profile output
Caveats
Summary
Functions
profile/2
mix profile.fprof
Sections
Command line options
Profile output
Caveats
Summary
Functions
profile/2
mix profile.tprof
Sections
Command line options
Profile output
Caveats
Summary
Functions
profile/2
mix release
Sections
Why releases?
Running the release
Deployments
Shutting down
Customization
Application configuration
Directory structure
Environment variables
Umbrellas
Hot Code Upgrades
Command line options
mix release.init
mix run
Sections
Command-line options
mix test
Sections
Understanding test results
Command line options
Configuration
Coloring
Filters
Coverage
Operating system process partitioning
The --stale option
File-system watchers
Aborting the suite
mix test.coverage
Sections
Line coverage
Exporting coverage
mix xref
Sections
A brief introduction to xref
mix xref trace FILE
mix xref graph
Shared options
Summary
Functions
calls/1
Search documentation of Mix
Settings
mix iex
(Mix v1.18.3)
View Source
A task that simply instructs users to run
iex -S mix
.