在 VS Code 中试用！

终端 Shell 集成

Visual Studio Code 能够与常见的 shell 集成，使终端能够更好地了解 shell 内部实际发生的情况。这些附加信息支持一些有用的功能，例如工作目录检测和命令检测、装饰器和导航。

支持的 shell

  • Linux/macOS: bash, fish, pwsh, zsh
  • Windows: Git Bash, pwsh

安装

自动脚本注入

默认情况下，shell 集成脚本应在从 VS Code 启动的支持 shell 上自动激活。这是通过在 shell 会话启动时注入参数和/或环境变量来实现的。可以通过将 terminal.integrated.shellIntegration.enabled 设置为 false 来禁用此自动注入。

这种标准的简便方法不适用于某些高级用例，例如子 shell 中、通过常规 ssh 会话（未使用 Remote - SSH 扩展时）或某些复杂的 shell 设置。建议针对这些情况启用 shell 集集成的推荐方法是手动安装。

注意：自动注入可能不适用于旧版本的 shell，例如旧版本的 fish 不支持 $XDG_DATA_DIRS 环境变量，这是注入的工作方式。你仍然可以尝试手动安装以使其工作。

手动安装

要手动安装 shell 集成，VS Code shell 集成脚本需要在 shell 初始化期间运行。在哪里以及如何执行此操作取决于你使用的 shell 和操作系统。手动安装时，建议将 terminal.integrated.shellIntegration.enabled 设置为 false，尽管这不是强制性的。

提示：使用 Insiders 构建版本时，请将下面的 code 替换为 code-insiders。

bash

将以下内容添加到你的 ~/.bashrc 文件中。在 bash 中运行 code ~/.bashrc 以在 VS Code 中打开文件。

[[ "$TERM_PROGRAM" == "vscode" ]] && . "$(code --locate-shell-integration-path bash)"

fish

将以下内容添加到你的 config.fish 中。在 fish 中运行 code $__fish_config_dir/config.fish 以在 VS Code 中打开文件。

string match -q "$TERM_PROGRAM" "vscode"
and . (code --locate-shell-integration-path fish)

pwsh

将以下内容添加到你的 PowerShell 配置文件中。在 pwsh 中运行 code $Profile 以在 VS Code 中打开文件。

if ($env:TERM_PROGRAM -eq "vscode") { . "$(code --locate-shell-integration-path pwsh)" }

zsh

将以下内容添加到你的 ~/.zshrc 文件中。在 zsh 中运行 code ~/.zshrc 以在 VS Code 中打开文件。

[[ "$TERM_PROGRAM" == "vscode" ]] && . "$(code --locate-shell-integration-path zsh)"

Git Bash

将以下内容添加到你的 ~/.bashrc 文件中。在 Git Bash 中运行 code ~/.bashrc 以在 VS Code 中打开文件。

[[ "$TERM_PROGRAM" == "vscode" ]] && . "$(code --locate-shell-integration-path bash)"

可移植性与性能

如果 code 位于 $PATH 中，上述 shell 集成安装是跨平台的，并且与任何安装类型兼容。但是，这种推荐的方法会启动 Node.js 来获取脚本路径，从而导致 shell 启动时略有延迟。为了减轻这种延迟，你可以提前解析路径并将上面的脚本直接内联到你的初始化脚本中。

# Output the executable's path first:
code --locate-shell-integration-path bash

# Add the result of the above to the source statement:
[[ "$TERM_PROGRAM" == "vscode" ]] && . "/path/to/shell/integration/script.sh"

命令装饰器和概览标尺

shell 集成的一项功能是能够获取在终端中运行的命令的退出代码。利用此信息，会在行左侧添加装饰器以指示命令是成功还是失败。这些装饰器也显示在滚动条中相对较新的概览标尺中，就像在编辑器中一样。

Blue circles appear next to successful commands, red circles with crosses appear next to failed commands. The color of the circles appears in the scroll bar

可以与装饰器交互以获取一些上下文操作，例如重新运行命令

Clicking a successful command decoration shows a context menu containing items: Copy Output, Copy Output as HTML, Rerun Command and How does this work?

可以通过 terminal.integrated.shellIntegration.decorationsEnabled 设置来配置命令和概览标尺装饰器。

命令导航

shell 集成检测到的命令会馈送到命令导航功能（Ctrl/Cmd+Up、Ctrl/Cmd+Down），使其具有更可靠的命令位置。此功能允许在命令之间快速导航并选择其输出。要从当前位置选择到命令，你还可以按住 Shift，按下 Shift+Ctrl/Cmd+Up 和 Shift+Ctrl/Cmd+Down。

命令指南

命令指南是一条在悬停命令及其输出时显示的条。这有助于更快地识别命令，也是验证 shell 集成是否正常工作的一种方法。

Screenshot of the terminal, highlighting the command guide vertical bar on the left-hand side to indicate the boundary of a command.

你可以使用颜色主题来自定义命令指南的颜色。要切换命令指南，请配置 terminal.integrated.shellIntegration.showCommandGuide 设置。

粘滞滚动

粘滞滚动功能会将部分显示的命令“固定”在终端顶部，从而更容易看到输出属于哪个命令。单击粘滞滚动组件将滚动到终端缓冲区中命令的位置。

Sticky scroll will show the command at the top of the terminal viewport

可以使用 terminal.integrated.stickyScroll.enabled 设置启用此功能。

快速修复

VS Code 会扫描命令的输出，并提供一个快速修复，其中包含用户下一步很可能想要执行的操作。

Running 'git push --set-upstream' will present a lightbulb that opens a dropdown with an option to open a new PR on github.com

以下是一些内置的快速修复

  • 检测到某个端口已被监听时，建议终止该进程并重新运行上一个命令。
  • 当 git push 因未设置上游而失败时，建议使用已设置的上游进行推送。
  • 当 git 子命令失败并出现类似命令错误时，建议使用类似的命令。
  • 当 git push 建议创建 GitHub PR 时，建议打开该链接。
  • 当 General 或 cmd-not-found PowerShell 反馈提供程序触发时，建议每个建议。

快速修复功能还支持 辅助功能信号，以便在快速修复可用时提供附加反馈。

运行最近的命令

终端：运行最近命令命令在快速选择中显示来自各种来源的历史记录，提供类似于 shell 的反向搜索（Ctrl+R）的功能。来源是当前会话的历史记录、此 shell 类型的上一个会话历史记录以及通用 shell 历史记录文件。

The "run recent command" command shows a quick pick with previously run commands that can be filtered similar to the go to file command

该命令的其他一些功能

  • 默认情况下，搜索模式是“连续搜索”，这意味着搜索词必须完全匹配。搜索输入框右侧的按钮允许切换到模糊搜索。
  • 在当前会话部分，快速选择右侧有一个剪贴板图标，可用于在编辑器中打开命令输出。
  • 快速选择右侧的固定操作可以将命令固定到列表顶部。
  • 可以按住 Alt 将文本写入终端而不运行它。
  • 上一个会话部分中存储的历史记录量由 terminal.integrated.shellIntegration.history 设置确定。

此命令的默认键盘快捷方式是 Ctrl+Alt+R。但是，当辅助功能模式开启时，这些会颠倒；Ctrl+R 运行最近的命令，Ctrl+Alt+R 将 Ctrl+R 发送给 shell。

当辅助功能模式关闭时，可以使用以下键盘快捷方式翻转键盘快捷方式

{
    "key": "ctrl+r",
    "command": "workbench.action.terminal.runRecentCommand",
    "when": "terminalFocus"
},
{
  "key": "ctrl+alt+r",
  "command": "workbench.action.terminal.sendSequence",
  "args": { "text": "\u0012"/*^R*/ },
  "when": "terminalFocus"
}

前往最近的目录

与运行最近命令功能类似，终端：前往最近目录命令会跟踪已访问过的目录，并允许快速筛选和导航 (cd) 到它们。Alt 可以按住以将文本写入终端而不运行它。

此命令的默认键盘快捷方式是 ⌘G (Windows, Linux Ctrl+G)，因为它与编辑器中的前往行/列命令行为类似。Ctrl+Alt+G 可以将 Ctrl+G 发送给 shell。

当前工作目录检测

Shell 集成告诉 VS Code shell 的当前工作目录是什么。在 Windows 上，如果不通过正则表达式尝试检测提示符，则无法获取此信息，并且在 macOS 和 Linux 上需要轮询，这对性能不利。

此功能支持的一项最重要的特性是增强了终端中链接的解析。以链接 package.json 为例，如果在禁用 shell 集成的情况下激活链接，如果工作区中有多个 package.json 文件，则会打开一个以 package.json 为过滤条件的搜索快速选择。但是，如果启用了 shell 集成，它会直接打开当前文件夹中的 package.json 文件，因为已知当前位置。这使得例如 ls 的输出能够可靠地打开正确的文件。

当前工作目录也用于在终端选项卡中、运行最近命令的快速选择中以及 "terminal.integrated.splitCwd": "inherited" 功能中显示目录。

扩展的 PowerShell 键盘快捷方式

Windows 的控制台 API 允许比 Linux/macOS 终端使用更多的键盘快捷方式，因为 VS Code 的终端即使在 Windows 上也模拟后者，所以由于缺乏 VT 编码（例如 Ctrl+Space），使用标准方法无法实现某些 PowerShell 键盘快捷方式。Shell 集成允许 VS Code 附加自定义键盘快捷方式，以向 PowerShell 发送特殊序列，然后在 shell 集成脚本中进行处理并转发到适当的按键处理程序。

启用 shell 集成后，以下键盘快捷方式应在 PowerShell 中工作

  • Ctrl+Space：在 Windows 上默认值为 MenuComplete
  • Alt+Space：在所有平台上默认值为 SetMark
  • Shift+Enter：在所有平台上默认值为 AddLine
  • Shift+End：在所有平台上默认值为 SelectLine
  • Shift+Home：在所有平台上默认值为 SelectBackwardsLine

PowerShell 的实验性智能感知

PowerShell 的实验性智能感知在 PowerShell 中输入时显示完成列表，类似于编辑器体验。在后台，此功能由 PowerShell 会话的原生完成 API 提供支持，因此可以使用变量等上下文感知补全。

PowerShell IntelliSense shows completions like Get-Alias, Get-ChildItem, for example when typing Get-

你可以使用 terminal.integrated.suggest.enabled 设置启用 PowerShell 的实验性智能感知。

"terminal.integrated.suggest.enabled": true

注意：此功能目前仅在 Windows 和 macOS 上可用。

Git 和 VS Code 补全

启用实验性智能感知后，默认情况下会为 CLI git、code 和 code-insiders 打开补全功能。如果你的 PowerShell 配置文件已有补全功能，你可能希望使用 terminal.integrated.suggest.builtinCompletions 设置关闭这些功能。

增强的辅助功能

shell 集成为 VS Code 提供的信息用于改进终端中的辅助功能。一些增强功能的示例包括

  • 在可访问缓冲区中导航检测到的命令（⌥F2 (Windows Alt+F2, Linux Shift+Alt+F2)）
  • 命令失败时会播放音频提示。
  • 底层文本框同步，使得使用方向键和退格键的行为更正确。

支持的转义序列

VS Code 支持几种自定义转义序列

VS Code 自定义序列 'OSC 633 ; ... ST'

VS Code 有一组自定义转义序列，旨在在 VS Code 的终端中运行时启用 shell 集成功能。这些序列由内置脚本使用，但也可以由任何能够向终端发送序列的应用程序使用，例如Julia 扩展使用这些序列来支持 Julia REPL 中的 shell 集成。

这些序列应该被其他终端忽略，但除非其他终端更广泛地采用这些序列，否则建议在写入之前检查 $TERM_PROGRAM 是否为 vscode。

  • OSC 633 ; A ST - 标记提示符开始。

  • OSC 633 ; B ST - 标记提示符结束。

  • OSC 633 ; C ST - 标记执行前。

  • OSC 633 ; D [; <exitcode>] ST - 标记执行完成，带可选退出代码。

  • OSC 633 ; E ; <commandline> [; <nonce] ST - 显式设置命令行，带可选随机数。

    E 序列允许终端可靠地获取 shell 解释的精确命令行。如果未指定此序列，终端可能会回退到使用 A、B 和 C 序列来获取命令，或者如果不可靠则完全禁用检测。

    可选的随机数可用于验证序列是否来自 shell 集成脚本，以防止命令欺骗。成功验证随机数后，在使用命令之前会移除一些保护，以改善用户体验。

    命令行可以使用 \xAB 格式转义 ASCII 字符，其中 AB 是字符代码的十六进制表示（不区分大小写），并使用 \\ 转义 \ 字符。需要转义分号 (0x3b) 和 0x20 及以下字符，这对换行符和分号尤为重要。

    一些示例

    "\"  -> "\\"
"\n" -> "\x0a"
";"  -> "\x3b"

  • OSC 633 ; P ; <Property>=<Value> ST - 在终端上设置一个属性，只会处理已知属性。

    已知属性

    • Cwd - 向终端报告当前工作目录。
    • IsWindows - 指示终端是否使用 winpty 或 conpty 等 Windows 后端。这可用于启用额外的启发式算法，因为 shell 集成序列的位置不保证是正确的。有效值是 True 和 False。

Final Term shell 集成

VS Code 支持 Final Term 的 shell 集成序列，这允许非 VS Code shell 集成脚本在 VS Code 中工作。这会导致体验有所下降，因为它不像 OSC 633 那样支持许多功能。以下是支持的特定序列

  • OSC 133 ; A ST - 标记提示符开始。
  • OSC 133 ; B ST - 标记提示符结束。
  • OSC 133 ; C ST - 标记执行前。
  • OSC 133 ; D [; <exitcode>] ST - 标记执行完成，带可选退出代码。

iTerm2 shell 集成

支持 iTerm2 首创的以下序列

  • OSC 1337 ; CurrentDir=<Cwd> S - 设置终端的当前工作目录，类似于 OSC 633 ; P ; Cwd=<Cwd> ST。

  • OSC 1337 ; SetMark ST - 在触发该行的左侧添加一个标记，并在滚动条中添加注释

    When the sequence is written to the terminal a small grey circle will appear to the left of the command, with a matching annotation in the scroll bar

    这些标记与命令导航集成，使其易于通过 ⌘↑ (Windows, Linux Ctrl+Up) 和 ⌘↓ (Windows, Linux Ctrl+Down) 导航到。

常见问题

自动注入何时不起作用？

有几种情况自动注入不起作用，以下是一些常见情况

  • $PROMPT_COMMAND 的格式不受支持，将其更改为指向单个函数是解决此问题的一种简便方法。例如

    prompt() {
  printf "\033]0;%s@%s:%s\007" "${USER}" "${HOSTNAME%%.*}" "${PWD/#$HOME/\~}"
}
PROMPT_COMMAND=prompt

  • 某些 shell 插件在初始化时可能会通过取消设置 $VSCODE_SHELL_INTEGRATION 来明确禁用 VS Code 的 shell 集成。

为什么禁用该功能时仍显示命令装饰器？

可能的原因是你的系统安装了 VS Code 可以理解的用于其他终端的 shell 集成。如果你不想要任何装饰器，可以使用以下设置将其隐藏

"terminal.integrated.shellIntegration.decorationsEnabled": never

另外，你可以从你的 shell rc/启动脚本中移除 shell 集成脚本，但这会让你无法使用命令感知功能，例如命令导航。

为什么命令装饰器在 Windows 上会跳动？

Windows 使用一个名为 ConPTY 的模拟伪终端 (pty) 后端。它与常规 pty 的工作方式略有不同，因为它需要保持与 Windows 控制台 API 的兼容性。其中一个影响是 pty 以特殊方式处理渲染，使得标识终端缓冲区中命令的 shell 集成序列可能会错位。当命令跳动时，通常是在命令运行之后，并且 VS Code 的启发式算法已启动以改进命令装饰器的位置。

05/08/2025