🚀 在 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 文件中。在 bash 中运行 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+向上，Ctrl/Cmd+向下），从而为其提供更可靠的命令位置。此功能允许在命令之间快速导航并选择其输出。要从当前位置选择到命令，您还可以按住 Shift，然后按 Shift+Ctrl/Cmd+向上 和 Shift+Ctrl/Cmd+向下。

命令指南

命令指南是在悬停时显示在命令及其输出旁边的栏。这有助于更快地识别命令，也是验证 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 编码，某些 PowerShell 键盘快捷方式无法使用标准方式实现，例如 Ctrl+空格键。Shell 集成允许 VS Code 附加自定义键盘快捷方式以将特殊序列发送到 PowerShell，然后该序列在 shell 集成脚本中处理并转发到正确的密钥处理程序。

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

  • Ctrl+空格键：默认情况下仅在 Windows 上为 MenuComplete
  • Alt+空格键：默认情况下在所有平台上为 SetMark
  • Shift+Enter：默认情况下在所有平台上为 AddLine
  • Shift+End：默认情况下在所有平台上为 SelectLine
  • Shift+Home：默认情况下在所有平台上为 SelectBackwardsLine

PowerShell 的实验性 IntelliSense

PowerShell 的实验性 IntelliSense 在 PowerShell 中键入时显示完成列表，类似于编辑器体验。在幕后，此功能由 PowerShell 会话的本机完成 API 提供支持，因此可以使用上下文感知的完成，例如变量。

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

您可以使用terminal.integrated.suggest.enabled 设置为 PowerShell 启用实验性 IntelliSense。

"terminal.integrated.suggest.enabled": true

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

Git 和 VS Code 完成

当启用实验性 IntelliSense 时，默认情况下会启用 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 - 显式设置命令行，带有可选的 nonce。

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

    可选的 nonce 可用于验证序列是否来自 shell 集成脚本，以防止命令欺骗。当 nonce 验证成功后，将删除使用命令之前的一些保护措施，以改善用户体验。

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

    一些示例

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

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

    已知属性

    • Cwd - 向终端报告当前工作目录。
    • IsWindows - 指示终端是否正在使用 Windows 后端，如 winpty 或 conpty。这可能用于启用其他启发式方法，因为 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 集成。

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

可能的原因是您的系统安装了另一个终端的 shell 集成，而 VS Code 可以理解。如果您不想要任何装饰，可以使用以下设置隐藏它们

"terminal.integrated.shellIntegration.decorationsEnabled": never

或者，您可以从 shell rc/启动脚本中删除 shell 集成脚本，但您将无法访问命令感知功能，例如命令导航。

为什么命令装饰在 Windows 上跳来跳去？

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

04/03/2025