尝试以扩展 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 会话（当不使用远程 - 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 集成质量

使用 shell 集成时，它有一个与之关联的“质量”，用于声明其功能。这些质量由 shell 集成脚本的行为方式决定。

  • 无：没有活动的 shell 集成。
  • 丰富：Shell 集成处于活动状态，并且命令检测以理想方式工作。
  • 基本：Shell 集成处于活动状态，但命令检测可能不支持所有功能。例如，可以检测到命令运行位置，但无法检测到其退出状态。

要查看 shell 集成质量，请将鼠标悬停在终端选项卡上。或者，在悬停时选择显示详细信息以查看更详细的信息。

命令装饰和概览标尺

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 上也模拟后者，因此有些 PowerShell 键盘快捷键由于缺少 VT 编码而无法通过标准方式实现，例如 Ctrl+Space。Shell 集成允许 VS Code 附加一个自定义键盘快捷键，向 PowerShell 发送一个特殊序列，然后由 shell 集成脚本处理并转发到正确的按键处理程序。

当启用 shell 集成时，以下键盘快捷键应在 PowerShell 中工作

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

增强的辅助功能

shell 集成提供给 VS Code 的信息用于改善终端中的辅助功能。一些增强功能的示例是

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

智能感知（预览）

终端中的智能感知使你能够接收有关文件、文件夹、命令、命令参数和选项的建议。此功能由 shell 集成 terminal.integrated.shellIntegration.enable 提供支持，并可通过 terminal.integrated.suggest.enabled 启用。

A user has typed git checkout in a terminal and requests completions. The completion list shows branch names like main and merogge/terminal-section

VS Code 从 Fig 规范中获取命令，并根据 $PATH 验证每个 shell 的内置函数（对于 pwsh、bash、zsh 和 fish），以确保它们存在。在 Windows 上，你可以使用 terminal.integrated.suggest.windowsExecutableExtensions 设置来配置特定的可执行文件集。

键盘导航

默认情况下，Tab 键插入建议。一旦在列表中进行了导航，Enter 键也会同样插入建议。你可以使用 terminal.integrated.suggest.selectionMode 设置来配置此行为。

要在接受时同时在终端中插入并运行补全，请配置 terminal.integrated.suggest.runOnEnter。

智能感知可以手动触发 ⌃Space (Windows, Linux Ctrl+Space)，也可以通过键入来触发，这可以通过 terminal.integrated.suggest.quickSuggestions 禁用。当键入某些字符（例如 /）时，也可以触发智能感知，这可以通过 terminal.integrated.suggest.suggestOnTriggerCharacters 进行配置。

当 shell 提供内联补全时，VS Code 会将其作为列表中的第一个补全项显示。你可以使用 terminal.integrated.suggest.inlineSuggestion 设置进一步配置此行为。

terminal.integrated.suggest.showStatusBar 设置控制是否在列表底部显示状态栏。此状态栏提供诸如了解更多（⇧⌘L (Windows, Linux Ctrl+Shift+L)）、插入（Tab）和配置（⇧⌘, (Windows, Linux Ctrl+Shift+,)）等操作。当你前几次使用智能感知功能时，了解更多操作会高亮显示以增加可发现性。

建议控件可以显示有关建议的额外详细信息。你可以使用 ⌃Space (Windows, Linux Ctrl+Space) 来切换这些详细信息的可见性。屏幕阅读器用户可以使用 ⌃⌥Space (Windows, Linux Ctrl+Alt+Space) 将焦点放在详细信息控件上，以听取其朗读。

支持的转义序列

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：指示终端是否正在使用像 winpty 或 conpty 这样的 Windows 后端。这可用于启用额外的启发式方法，因为 shell 集成序列的定位不保证是正确的。有效值为 True 和 False。
    • HasRichCommandDetection：指示终端是否具有丰富的命令检测功能。当 shell 集成脚本按 VS Code 期望的理想方式运行时，此属性设置为 True，具体来说，序列应按 A, B, E, C, D 的顺序出现在预期的位置。

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 的启发式方法介入以改善命令装饰的位置。

08/07/2025