1ELIXIR(1)                 BSD General Commands Manual                ELIXIR(1)
2

NAME

4     elixir — The Elixir script runner
5

SYNOPSIS

7     elixir [OPTIONS] file ...
8

DESCRIPTION

10     The program starts the runtime system typically for the execution of one
11     or more scripts. It is similar to iex(1), but elixir exits when the exe‐
12     cuted script does.
13

OPTIONS

15     Note that many of the options mentioned here were borrowed from the Er‐
16     lang shell, therefore erl(1) can be used as an additional source of in‐
17     formation on the options.
18
19     -h, --help
20             Displays the help message to the standard error (stderr) and ex‐
21             its.
22
23     -v, --version
24             Displays the Elixir version to the standard output (stdout) and
25             exits.
26
27     -e, --eval expression
28             Evaluates the specified expression (see the --rpc-eval option).
29
30     -r file
31             Requires the specified file. In other words, the file is checked
32             for existence at the start of elixir.
33
34     -S script
35             Runs the specified script.
36
37     -pa directory
38             Adds the specified directory to the beginning of the code path.
39             If the directory already exists, it will be removed from its old
40             position and put to the beginning.
41
42             See also the function Code.prepend_path/1.
43
44     -pr file
45             Does the same thing as -r (see above) but in parallel.
46
47     -pz directory
48             Adds the specified directory to the end of the code path. If the
49             directory already exists, it will be neither removed from its old
50             position nor put to the end.
51
52             See also the function Code.append_path/1.
53
54     --app application
55             Starts the specified application and all its dependencies.
56
57     --boot file
58             Specifies the name of the boot file, file.boot, which is used to
59             start the system. Unless File contains an absolute path, the
60             system searches for file.boot in the current and $ROOT/bin
61             directories.
62
63             Defaults to $ROOT/bin/start.boot.
64
65             The option is equivalent to Erlang's -boot.
66
67     --boot-var var dir
68             If the boot script contains a path variable var other than $ROOT,
69             this variable is expanded to dir.  Used when applications are in‐
70             stalled in another directory than $ROOT/lib.
71
72             The option is equivalent to Erlang's -boot_var.
73
74             See also the function :systools.make_script/1,2 in SASL.
75
76     --erl parameters
77             Serves the same purpose as ELIXIR_ERL_OPTIONS (see the
78             ENVIRONMENT section)
79
80     --erl-config file
81             Specifies the name of a configuration file, file.config, which is
82             used to configure applications. Note that the configuration file
83             must be written in Erlang.
84
85             The option is equivalent to Erlang's -config.
86
87     --cookie value
88             Specifies the magic cookie value. If the value isn't specified
89             via the option when the node starts, it will be taken from the
90             file ~/.erlang.cookie (see the FILES section).  Distributed nodes
91             can interact with each other only when their magic cookies are
92             equal.
93
94             See also the function Node.set_cookie/2.
95
96     --hidden
97             Starts a hidden node.
98
99             Connections between nodes are transitive. For example, if node A
100             is connected to node B, and node B is connected to node C, then
101             node A is connected to node C. The option --hidden allows creat‐
102             ing a node which can be connected to another node, escaping re‐
103             dundant connections.
104
105             The function Node.list/0 allows getting the list of nodes con‐
106             nected to the target node, however the list won't include hidden
107             nodes. Depending on the input parameter, the function Node.list/1
108             allows getting the list which contains only hidden nodes (the
109             parameter :hidden) or both hidden and not hidden nodes (the
110             parameter :connected).
111
112     --logger-otp-reports val
113             Enables or disables OTP reporting (val can be either true or
114             false).
115
116     --logger-sasl-reports val
117             Enables or disables SASL reporting (val can be either true or
118             false).
119
120     --sname name
121             Gives a node a short name and starts it. Short names take the
122             form of name@host, where host is the name of the target host
123             (hostname(1)) which runs the node. The nodes with short names can
124             interact with each other only in the same local network.
125
126     --name name
127             Gives a node a long name and starts it. Long names take the form
128             of name@host, where host is the IP address of the host which runs
129             the node. In contrast to the nodes with short names, the nodes
130             with long names aren't limited by boundaries of a local network
131             (see above).
132
133     --pipe-to pipedir logdir
134             Starts the Erlang VM as a named pipedir and logdir (only for
135             Unix-like operating systems).
136
137     --rpc-eval node expression
138             Evaluates the specified expression on the specified node (see the
139             --eval option).
140
141     --vm-args file
142             Reads the command-line arguments from file and passes them to the
143             Erlang VM.
144
145             The option is equivalent to Erlang's -args_file.
146
147     --werl  Uses Erlang's Windows shell GUI (only for Windows).
148
149     --no-halt
150             Does not halt the Erlang VM after execution.
151
152     --      Separates the options passed to the compiler from the options
153             passed to the executed code.
154

NOTES

156     The following options can be given more than once: --boot-var,
157     --erl-config, --eval, --rpc-eval.
158

ENVIRONMENT

160     ELIXIR_ERL_OPTIONS
161             Allows passing parameters to the Erlang runtime.
162

FILES

164     ~/.erlang.cookie
165             Stores the magic cookie value which is used only when it wasn't
166             specified via the option --cookie (see above).  If the file
167             doesn't exist when a node starts, it will be created.
168

SEE ALSO

170     elixirc(1), iex(1), mix(1)
171

AUTHOR

173     Elixir is maintained by The Elixir Team.
174
175     This manual page was contributed by Evgeny Golyshev.
176
177     Copyright (c) 2012 Plataformatec.
178
179     Copyright (c) 2021 The Elixir Team.
180

INTERNET RESOURCES

182     Main website: https://elixir-lang.org
183
184     Documentation: https://elixir-lang.org/docs.html
185
186BSD                            February 3, 2019                            BSD
Impressum