Note that many of the options mentioned here were borrowed from the Erlang shell, therefore erl(1) can be
used as an additional source of information on the options.
-h, --help
Displays the help message to the standard error (stderr) and exits.
-v, --version
Displays the Elixir version to the standard output (stdout) and exits.
-e, --evalexpression
Evaluates the specified expression (see the --rpc-eval option).
-rfile
Requires the specified file. In other words, the file is checked for existence at the start of
elixir.
-Sscript
Runs the specified script.
-padirectory
Adds the specified directory to the beginning of the code path. If the directory already exists,
it will be removed from its old position and put to the beginning.
See also the function Code.prepend_path/1.
-prfile
Does the same thing as -r (see above) but in parallel.
-pzdirectory
Adds the specified directory to the end of the code path. If the directory already exists, it
will be neither removed from its old position nor put to the end.
See also the function Code.append_path/1.
--appapplication
Starts the specified application and all its dependencies.
--bootfile
Specifies the name of the boot file, file.boot, which is used to start the system. Unless File
contains an absolute path, the system searches for file.boot in the current and $ROOT/bin
directories.
Defaults to $ROOT/bin/start.boot.
The option is equivalent to Erlang's -boot.
--boot-varvardir
If the boot script contains a path variable var other than $ROOT, this variable is expanded to
dir. Used when applications are installed in another directory than $ROOT/lib.
The option is equivalent to Erlang's -boot_var.
See also the function :systools.make_script/1,2 in SASL.
--erlparameters
Serves the same purpose as ELIXIR_ERL_OPTIONS (see the ENVIRONMENT section)
--erl-configfile
Specifies the name of a configuration file, file.config, which is used to configure applications.
Note that the configuration file must be written in Erlang.
The option is equivalent to Erlang's -config.
--cookievalue
Specifies the magic cookie value. If the value isn't specified via the option when the node
starts, it will be taken from the file ~/.erlang.cookie (see the FILES section). Distributed
nodes can interact with each other only when their magic cookies are equal.
See also the function Node.set_cookie/2.
--hidden
Starts a hidden node.
Connections between nodes are transitive. For example, if node A is connected to node B, and node
B is connected to node C, then node A is connected to node C. The option --hidden allows creating
a node which can be connected to another node, escaping redundant connections.
The function Node.list/0 allows getting the list of nodes connected to the target node; however,
the list won't include hidden nodes. Depending on the input parameter, the function Node.list/1
allows getting the list which contains only hidden nodes (the parameter :hidden) or both hidden
and not hidden nodes (the parameter :connected).
--logger-otp-reportsval
Enables or disables OTP reporting (val can be either true or false).
--logger-sasl-reportsval
Enables or disables SASL reporting (val can be either true or false).
--snamename
Gives a node a short name and starts it. Short names take the form of name@host, where host is
the name of the target host (hostname(1)) which runs the node. The nodes with short names can
interact with each other only in the same local network.
--namename
Gives a node a long name and starts it. Long names take the form of name@host, where host is the
IP address of the host which runs the node. In contrast to the nodes with short names, the nodes
with long names aren't limited by boundaries of a local network (see above).
--pipe-topipedirlogdir
Starts the Erlang VM as a named pipedir and logdir (only for Unix-like operating systems).
--rpc-evalnodeexpression
Evaluates the specified expression on the specified node (see the --eval option).
--vm-argsfile
Reads the command-line arguments from file and passes them to the Erlang VM.
The option is equivalent to Erlang's -args_file.
--no-halt
Does not halt the Erlang VM after execution.
-- Separates the options passed to the compiler from the options passed to the executed code.