Elixir 的交互式 shell。

这里描述的一些功能可能在您的终端上不可用。特别是，如果您收到一条消息，表明智能终端无法运行，这里描述的一些功能将无法使用。

助手

IEx 提供了许多助手。您可以通过在 shell 中键入 h() 或作为 IEx.Helpers 模块的文档来访问它们。

自动完成

要发现模块的公共函数或其他模块，请键入模块名称后跟一个点，然后按 Tab 键触发自动完成。例如

Enum.

一个模块可能会导出一些不适合直接使用的函数：这些函数不会被 IEx 自动完成。IEx 不会自动完成带有 @doc false、@impl true 注解的函数，或者未显式记录且函数名称为 __foo__ 形式的函数。

自动完成默认情况下在 Erlang/OTP 26 中的 Windows shell 上可用。在早期版本中，您可能需要在启动 IEx 时传递 --werl 选项，例如 iex --werl（或者如果使用 PowerShell，则使用 iex.bat --werl）。--werl 可以通过将 IEX_WITH_WERL 环境变量设置为 1 来永久启用。

编码和颜色

IEx 期望输入和输出采用 UTF-8 编码。这是大多数 Unix 终端的默认设置，但 Windows 上可能并非如此。如果您在 Windows 上运行并且看到打印的错误值，您可能需要通过运行 chcp 65001 来更改当前会话的编码，然后再调用 iex（或者如果使用 PowerShell，则在调用 iex.bat 之前）。

同样，ANSI 颜色默认情况下在大多数 Unix 终端上启用。它们也适用于 Windows 10 上的 Windows 控制台以及 Erlang/OTP 26 或更高版本。对于早期版本的 Erlang/OTP，您可以通过运行以下命令在注册表中为当前用户显式启用它

$ reg add HKCU\Console /v VirtualTerminalLevel /t REG_DWORD /d 1

运行完以上命令后，您必须重启当前控制台。

Shell 历史记录

可以通过传递一些选项在 VM 中启用它来获取 shell 历史记录。这可以在启动 IEx 时根据需要进行

$ iex --erl "-kernel shell_history enabled"

如果您希望在整个系统中启用它，可以使用 ERL_AFLAGS 环境变量，并确保它在您的终端/shell 配置中正确设置。

在类 Unix/Bash 上

$ export ERL_AFLAGS="-kernel shell_history enabled"

在 Windows 上

$ set ERL_AFLAGS "-kernel shell_history enabled"

在 Windows 10/PowerShell 上

$ $env:ERL_AFLAGS = "-kernel shell_history enabled"

IEx 中的表达式

作为交互式 shell，IEx 评估表达式。这有一些有趣的结论，值得讨论。

第一个是代码真正被评估，而不是被编译。这意味着在 shell 中进行的任何基准测试都会产生偏差的结果。因此，切勿在 shell 中运行任何性能分析或基准测试。

其次，IEx 允许您将表达式分解成多行，因为这在 Elixir 中很常见。例如

iex(1)> "ab
...(1)> c"
"ab\nc"

在上面的示例中，shell 会一直等待更多输入，直到找到闭合引号。有时 shell 期待哪个字符并不明显，用户可能会发现自己陷入不完整的表达式状态，无法终止它，除了退出 shell。

对于这种情况，有一个特殊的断点触发器 (#iex:break)，当它单独出现在一行时，会强制 shell 中断任何挂起的表达式，并返回到其正常状态

iex(1)> ["ab
...(1)> c"
...(1)> "
...(1)> ]
...(1)> #iex:break
** (TokenMissingError) iex:1: incomplete expression

将多行表达式粘贴到 IEx 中

IEx 以急切的方式逐行评估其输入。如果在一行结束时，到目前为止看到的代码是一个完整的表达式，IEx 将在此时对其进行评估。

iex(1)> [1, [2], 3]
[1, [2], 3]

为了防止这种行为破坏有效的代码，其中后续行以二元运算符开头，例如 |>/2 或 ++/2，IEx 自动将这些行视为在其前面添加了 IEx.Helpers.v/0，它返回前一个表达式的值（如果可用）。

iex(1)> [1, [2], 3]
[1, [2], 3]
iex(2)> |> List.flatten()
[1, 2, 3]

以上等同于

iex(1)> [1, [2], 3]
[1, [2], 3]
iex(2)> v() |> List.flatten()
[1, 2, 3]

如果历史记录中没有先前的表达式，管道运算符将失败

iex(1)> |> List.flatten()
** (RuntimeError) v(-1) is out of bounds

如果前一个表达式是一个匹配操作，管道运算符也会失败，以防止意外中断匹配

iex(1)> x = 42
iex(2)> |> IO.puts()
** (SyntaxError) iex:2:1: pipe shorthand is not allowed immediately after a match expression in IEx. To make it work, surround the whole pipeline with parentheses ('|>')
    |
  2 | |> IO.puts()
    | ^

但是，请注意，以上方法不适用于 +/2 和 -/2，因为它们与一元 +/1 和 -/1 模糊不清

iex(1)> 1
1
iex(2)> + 2
2

BREAK 菜单

在 IEx 内部，按 Ctrl+C 会打开 BREAK 菜单。在这个菜单中，您可以退出 shell，查看进程和 ETS 表信息等等。

退出 shell

有几种方法可以退出 IEx shell

• 通过 BREAK 菜单（通过 Ctrl+C 访问）键入 q，然后按 Enter 键
• 按 Ctrl+C、Ctrl+C
• 按 Ctrl+\

如果您连接到远程 shell，它在断开连接后会保持活动状态。

dbg 和断点

IEx 集成了 Kernel.dbg/2 并引入了一个可以暂停代码执行的后端。要启用它，您必须传递 --dbg pry

$ iex --dbg pry

例如，以下函数

def my_fun(arg1, arg2) do
  dbg(arg1 + arg2)
  ... implementation ...
end

当代码使用 iex 执行时（通常通过调用 iex --dbg pry -S mix），它会询问您是否允许使用“pry”。如果您同意，它将在上述函数的上下文中启动一个 IEx shell，并访问其变量、导入和别名。但是，您只能访问现有值，无法访问私有函数，也无法更改执行本身（因此称为“pry”）。

在管道末尾使用 |> dbg() 时，您可以窥探管道中的每个步骤。您可以在需要跳到下一个管道时键入 n。在您想要执行所有步骤但停留在被窥探的进程中时键入 continue。在您想要离开被窥探的进程并启动一个新 shell 时键入 respawn。

或者，您可以直接启动 pry 会话，无需使用 dbg/2，方法是调用 IEx.pry/0。

IEx 还允许您设置断点，以使用 IEx.break!/4 在您无法控制的特定模块、函数和元数上启动 pry 会话。类似于 dbg() 中的管道，IEx.break!/4 允许您逐行调试函数并访问其变量。但是，断点不包含来自源代码的导入和别名信息。

在使用 dbg 或断点进行测试时，请记住将 --trace 传递给 mix test，以避免遇到超时

$ iex -S mix test --trace
$ iex -S mix test path/to/file:line --trace

用户切换命令

除了 BREAK 菜单外，还可以键入 Ctrl+G 来进入 用户切换命令 菜单。进入后，您可以键入 h 以获取更多信息。

在这个菜单中，开发人员可以启动新的 shell 并切换它们。让我们试一试

User switch command
 --> s 'Elixir.IEx'
 --> c

上面的命令将启动一个新的 shell 并连接到它。创建一个名为 hello 的新变量，并为它分配一些值

hello = :world

现在，让我们回到第一个 shell

User switch command
 --> c 1

现在，尝试再次访问 hello 变量

hello
** (CompileError) undefined variable "hello"

上面的命令失败，因为我们已经切换了 shell。由于 shell 之间相互隔离，因此您无法从一个 shell 中访问在另一个 shell 中定义的变量。

用户切换命令 也可以用来终止现有的会话，例如当评估器陷入无限循环或您卡在键入表达式时

User switch command
 --> i
 --> c

用户切换命令 菜单还允许开发人员使用 r 命令连接到远程 shell。我们将在下一节讨论这个主题。

远程 shell

IEx 允许您以两种方式连接到另一个节点。首先，我们只能连接到一个 shell，如果我们为当前 shell 和我们要连接的 shell 都指定了名称。

让我们试一试。首先，启动一个新的 shell

$ iex --sname foo
iex(foo@HOST)1>

提示符中括号之间的字符串是您的节点名称。我们可以通过调用 node/0 函数来检索它

iex(foo@HOST)1> node()
:"foo@HOST"
iex(foo@HOST)2> Node.alive?()
true

为了好玩，让我们在这个 shell 中定义一个简单的模块

iex(foo@HOST)3> defmodule Hello do
...(foo@HOST)3>   def world, do: "it works!"
...(foo@HOST)3> end

现在，让我们启动另一个 shell，也为它命名

$ iex --sname bar
iex(bar@HOST)1>

如果我们尝试调度到 Hello.world/0，它将不可用，因为它只在另一个 shell 中定义

iex(bar@HOST)1> Hello.world()
** (UndefinedFunctionError) undefined function Hello.world/0

但是，我们可以远程连接到另一个 shell。打开 用户切换命令 提示符 (Ctrl+G) 并键入

User switch command
 --> r 'foo@HOST' 'Elixir.IEx'
 --> c

现在我们连接到远程节点，如提示符所示，我们可以访问那里定义的信息和模块

iex(foo@HOST)1> Hello.world()
"it works!"

事实上，连接到远程 shell 非常常见，以至于我们也提供了命令行的快捷方式

$ iex --sname baz --remsh foo@HOST

其中“remsh”表示“远程 shell”。一般来说，Elixir 支持

• 从 Elixir 节点到 Elixir 节点的 remsh
• 从普通 Erlang 节点到 Elixir 节点的 remsh（通过 ^G 菜单）
• 从 Elixir 节点到普通 Erlang 节点的 remsh（并在那里获取 erl shell）

不支持将 Elixir shell 连接到没有 Elixir 的远程节点。

.iex.exs 文件

启动时，IEx 会查找本地 .iex.exs 文件（位于当前工作目录），然后查找位于 IEX_HOME 环境变量指向的目录（默认为 ~）中的全局 .iex.exs 文件，并加载它找到的第一个文件（如果有）。

所选 .iex.exs 文件中的代码在 shell 的上下文中逐行评估，就像每行都在 shell 中键入一样。例如，在 .iex.exs 文件中加载的任何模块或绑定的任何变量，在 shell 启动后都将在 shell 中可用。

请使用以下 .iex.exs 文件

# Load another ".iex.exs" file
import_file("~/.iex.exs")

# Import some module from lib that may not yet have been defined
import_if_available(MyApp.Mod)

# Print something before the shell starts
IO.puts("hello world")

# Bind a variable that'll be accessible in the shell
value = 13

在包含上述 .iex.exs 文件的目录中运行 IEx 将得到以下结果

$ iex
Erlang/OTP 24 [...]

hello world
Interactive Elixir - press Ctrl+C to exit (type h() ENTER for help)
iex(1)> value
13

可以使用 --dot-iex 选项向 IEx 提供另一个文件。请参阅 iex --help。

对于远程节点，.iex.exs 文件的位置相对于启动应用程序的用户，而不是远程 IEx 连接时连接到节点的用户。

配置 shell

IEx 提供了许多自定义选项。通过输入 h IEx.configure/1 查看 IEx.configure/1 函数的文档。

这些选项可以在您的项目配置文件中配置，也可以通过从您的 ~/.iex.exs 文件调用 IEx.configure/1 全局配置。例如

# .iex.exs
IEx.configure(inspect: [limit: 3])

现在运行 shell

$ iex
Erlang/OTP 24 [...]

Interactive Elixir - press Ctrl+C to exit (type h() ENTER for help)
iex(1)> [1, 2, 3, 4, 5]
[1, 2, 3, ...]