使用 SSH 进行远程开发

Name: Visual Studio Code
Author: Microsoft

Visual Studio Code 远程 - SSH 扩展允许您在任何运行 SSH 服务器的远程机器、虚拟机或容器上打开远程文件夹，并充分利用 VS Code 的功能集。连接到服务器后，您可以与远程文件系统上的任何文件和文件夹进行交互。

无需在本地机器上放置源代码即可获得这些优势，因为该扩展直接在远程机器上运行命令和其他扩展。该扩展将在远程操作系统上安装 VS Code Server；该服务器独立于远程操作系统上任何现有的 VS Code 安装。

SSH Architecture

这使得 VS Code 能够提供本地质量的开发体验——包括完整的智能感知（补全）、代码导航和调试——无论您的代码托管在哪里。

入门

注意：阅读本主题后，您可以通过入门SSH 教程开始。

系统要求

本地： 还必须安装受支持的OpenSSH 兼容 SSH 客户端。

远程 SSH 主机：在以下系统上运行的SSH 服务器：

x86_64 Debian 8+、Ubuntu 16.04+、CentOS / RHEL 7+。
ARMv7l (AArch32) Raspberry Pi OS（以前称为 Raspbian）Stretch/9+ (32 位)。
ARMv8l (AArch64) Ubuntu 18.04+ (64 位)。
Windows 10 / Server 2016/2019 (1803+) 使用官方 OpenSSH Server。
macOS 10.14+ (Mojave) SSH 主机，已启用远程登录。
远程主机需要 1 GB RAM，但建议至少 2 GB RAM 和 2 核 CPU。

其他基于 glibc 的 x86_64、ARMv7l (AArch32) 和 ARMv8l (AArch64) Linux 发行版，如果具备所需先决条件，应该也能正常工作。有关先决条件以及获取社区支持的发行版并使其运行的提示，请参阅使用 Linux 进行远程开发文章。

虽然支持 ARMv7l (AArch32) 和 ARMv8l (AArch64)，但由于扩展中使用了 x86 本机代码，这些设备上安装的某些扩展可能无法工作。

安装

要开始使用，您需要

如果尚未安装，请安装OpenSSH 兼容 SSH 客户端。
安装Visual Studio Code或Visual Studio Code Insiders。
安装Remote-SSH 扩展。如果您计划在 VS Code 中使用其他远程扩展，您可以选择安装Remote Development 扩展包。

SSH 主机设置

如果您尚未设置 SSH 主机，请按照Linux、Windows 10 / Server (1803+) 或 macOS SSH 主机的说明进行操作，或者在 Azure 上创建虚拟机。
可选： 如果您的 Linux 或 macOS SSH 主机将同时被多个用户访问，请考虑在 VS Code 用户设置中启用 Remote.SSH: Remote Server Listen On Socket 以提高安全性。

在“设置”编辑器中

有关详细信息，请参阅提示和技巧文章。
可选： 虽然支持基于密码的身份验证，但我们建议为您的主机设置基于密钥的身份验证。有关详细信息，请参阅提示和技巧文章。

连接到远程主机

首次连接到远程主机，请按以下步骤操作

通过从终端/PowerShell 窗口运行以下命令来验证是否可以连接到 SSH 主机，并根据需要替换 user@hostname。
```
ssh user@hostname
# Or for Windows when using a domain / AAD account
ssh user@domain@hostname
```
在 VS Code 中，从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 选择 远程 - SSH: 连接到主机...，并使用与步骤 1 中相同的 user@hostname。
如果 VS Code 无法自动检测您正在连接的服务器类型，系统将要求您手动选择类型。

选择平台后，它将存储在VS Code 设置中的remote.SSH.remotePlatform属性下，因此您可以随时更改它。
片刻之后，VS Code 将连接到 SSH 服务器并自行设置。VS Code 将通过进度通知向您更新最新状态，您可以在 Remote - SSH 输出通道中查看详细日志。

提示： 连接挂起或失败？请参阅故障排除提示，了解解决常见问题的信息。

如果看到有关 SSH 文件权限的错误，请参阅修复 SSH 文件权限错误部分。
连接后，您将进入一个空窗口。您始终可以通过状态栏查看当前连接的主机。

点击状态栏项将在您连接时提供远程命令列表。
然后，您可以通过 文件 > 打开... 或 文件 > 打开工作区... 像在本地一样打开远程机器上的任何文件夹或工作区！

从这里，安装您在连接到主机时想要使用的任何扩展并开始编辑！

注意： 在 ARMv7l / ARMv8l glibc SSH 主机上，某些扩展可能因其内部的 x86 编译本地代码而无法工作。

在容器中打开远程 SSH 主机上的文件夹

如果您使用的是 Linux 或 macOS SSH 主机，您可以同时使用 Remote - SSH 和开发容器扩展，以在容器内打开远程主机上的文件夹。您甚至不需要在本地安装 Docker 客户端。

为此，请执行以下操作：

按照安装步骤在远程主机上安装 Docker，并在本地安装 VS Code 和 Dev Containers 扩展。
可选： 设置 SSH 基于密钥的身份验证到服务器，这样您就不需要多次输入密码。
按照 Remote - SSH 扩展的快速入门连接到主机并在那里打开一个文件夹。
从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 使用 开发容器: 在容器中重新打开 命令。

其余的开发容器快速入门按原样适用。您可以在其文档中了解更多关于开发容器扩展的信息。如果此模型不满足您的需求，您还可以查看在远程 Docker 主机上开发文章，了解其他选项。

断开与远程主机的连接

完成远程主机上的文件编辑后，若要关闭连接，请选择 文件 > 关闭远程连接 以断开与主机的连接。默认配置不包括此命令的键盘快捷方式。您也可以直接退出 VS Code 以关闭远程连接。

记住主机和高级设置

如果您经常使用一组主机，或者需要使用一些额外选项连接到主机，您可以将它们添加到遵循 SSH 配置文件格式的本地文件中。

为了便于设置，该扩展可以指导您添加主机，而无需手动编辑此文件。

首先从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 选择 远程 - SSH: 添加新的 SSH 主机...，或单击活动栏中 SSH 远程资源管理器中的 添加新 图标。

Remote Explorer Add New item

然后系统会要求您输入 SSH 连接信息。您可以输入主机名

Remote Explorer SSH host input

或者您将用于从命令行连接到主机的完整 ssh 命令

Remote Explorer SSH command input

最后，系统会要求您选择一个要使用的配置文件。如果您想使用与列表中不同的配置文件，您还可以在用户 settings.json 文件中设置 "remote.SSH.configFile" 属性。剩下的就由扩展来完成！

例如，在输入框中输入 ssh -i ~/.ssh/id_rsa-remote-ssh yourname@remotehost.yourcompany.com 将生成此条目

Host remotehost.yourcompany.com
    User yourname
    HostName another-host-fqdn-or-ip-goes-here
    IdentityFile ~/.ssh/id_rsa-remote-ssh

有关生成此处所示密钥的详细信息，请参阅提示和技巧。您可以使用 SSH 配置文件格式支持的任何内容手动编辑此文件，因此这只是一个示例。

从此刻起，当您从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 选择 远程 - SSH: 连接到主机... 时，或在 远程资源管理器 的 SSH 目标 部分中，该主机将出现在主机列表中。

SSH targets in the Remote Explorer

远程资源管理器 允许您在远程主机上打开一个全新的空窗口，或者直接打开您之前打开的文件夹。展开主机并单击您想在该主机上打开的文件夹旁边的 打开文件夹 图标。

Remote Explorer open folder

管理扩展

VS Code 在两个地方运行扩展：本地 UI/客户端侧，或远程 SSH 主机上。虽然影响 VS Code UI 的扩展（如主题和代码片段）安装在本地，但大多数扩展将驻留在 SSH 主机上。这确保了您拥有流畅的体验，并允许您从本地机器在 SSH 主机上安装给定工作区所需的任何扩展。这样，您可以从不同的机器上，带着您的扩展，准确地从上次中断的地方继续工作。

如果您从“扩展”视图安装扩展，它将自动安装到正确的位置。安装后，您可以根据类别分组判断扩展的安装位置。

将有一个用于您的远程 SSH 主机的类别

Workspace Extension Category

还有一个 本地 - 已安装 类别

Local Extension Category

注意： 如果您是扩展作者，发现您的扩展无法正常工作或安装到错误的位置，请参阅支持远程开发了解详细信息。

实际需要在远程运行的本地扩展将在 本地 - 已安装 类别中显示为灰色和禁用。选择安装以在远程主机上安装扩展。

Disabled Extensions w/Install Button

您还可以通过前往“扩展”视图，并使用 本地 - 已安装 标题栏右侧的云按钮，选择 在 SSH: {主机名} 中安装本地扩展，从而在 SSH 主机上安装所有本地安装的扩展。这将显示一个下拉菜单，您可以在其中选择要在 SSH 主机上安装的本地已安装扩展。

“始终安装”的扩展

如果您希望在任何 SSH 主机上始终安装某些扩展，您可以使用 settings.json 中的 remote.SSH.defaultExtensions 属性指定它们。例如，如果您想安装 GitLens 和 Resource Monitor 扩展，请按以下方式指定它们的扩展 ID：

"remote.SSH.defaultExtensions": [
    "eamodio.gitlens",
    "mutantdino.resourcemonitor"
]

高级：强制扩展在本地/远程运行

扩展通常被设计和测试为要么在本地运行，要么在远程运行，而不是两者兼而有之。但是，如果扩展支持，您可以在 settings.json 文件中强制它在特定位置运行。

例如，以下设置将强制容器工具扩展在本地运行，而远程 - SSH: 编辑配置文件扩展在远程运行，而不是它们的默认设置：

"remote.extensionKind": {
    "ms-azuretools.vscode-containers": [ "ui" ],
    "ms-vscode-remote.remote-ssh-edit": [ "workspace" ]
}

使用 "ui" 而非 "workspace" 值将强制扩展在本地 UI/客户端侧运行。通常，这仅应用于测试，除非扩展文档中另有说明，因为它可能会破坏扩展。有关详细信息，请参阅支持远程开发一文。

转发端口/创建 SSH 隧道

有时在开发过程中，您可能需要访问远程机器上未公开的端口。有两种方法可以使用 SSH 隧道来完成此操作，该隧道将所需的远程端口“转发”到您的本地机器。

临时转发端口

连接到主机后，如果您想在会话期间临时转发一个新端口，请从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 选择 转发端口，或在 端口视图 中选择 添加端口 按钮。您可以在底部面板中看到“端口”视图，或通过运行命令 端口: 聚焦端口视图。

Forward port button

系统将要求您输入要转发的端口，并可以为其命名。

Adding a new port

通知将告知您应使用哪个 localhost 端口来访问远程端口。例如，如果您转发了一个监听端口 3000 的 HTTP 服务器，通知可能会告诉您它被映射到 localhost 上的端口 4123，因为 3000 已在使用中。然后您可以使用 http://localhost:4123 连接到此远程 HTTP 服务器。

如果您需要稍后访问此信息，可以在远程资源管理器的 转发端口 部分中找到相同的信息。

如果您希望 VS Code 记住您已转发的任何端口，请在“设置”编辑器 (⌘, (Windows, Linux Ctrl+,)) 中勾选 远程: 恢复转发端口，或在 settings.json 中设置 "remote.restoreForwardedPorts": true。

Restore forwarded ports setting

更改隧道上的本地端口

如果您希望隧道的本地端口与远程服务器的不同，可以通过 转发端口 面板进行更改。

右键单击您要修改的隧道，然后在上下文菜单中选择 更改本地地址端口。

Change Local Address Port

始终转发端口

如果您有总是想要转发的端口，您可以在用于记住主机和高级设置的 SSH 配置文件中使用 LocalForward 指令。

例如，如果您想转发端口 3000 和 27017，您可以按如下方式更新文件

Host remote-linux-machine
    User myuser
    HostName remote-linux-machine.mydomain
    LocalForward 127.0.0.1:3000 127.0.0.1:3000
    LocalForward 127.0.0.1:27017 127.0.0.1:27017

在远程主机上打开终端

在 VS Code 中打开远程主机上的终端很简单。连接后，您在 VS Code 中打开的任何终端窗口 (终端 > 新建终端) 将自动在远程主机上运行，而不是在本地。

您还可以从此终端窗口中使用 code 命令行执行多项操作，例如在远程主机上打开新文件或文件夹。键入 code --help 以查看命令行中所有可用的选项。

Using the code CLI

在 SSH 主机上调试

连接到远程主机后，您可以像在本地运行应用程序时一样使用 VS Code 的调试器。例如，如果您在 launch.json 中选择一个启动配置并开始调试 (F5)，应用程序将在远程主机上启动并附着调试器。

有关在 .vscode/launch.json 中配置 VS Code 调试功能的详细信息，请参阅调试文档。

SSH 主机特定设置

当您连接到 SSH 主机时，VS Code 的本地用户设置也会被重复使用。虽然这保持了您用户体验的一致性，但您可能希望在本地机器和每个主机之间更改某些设置。幸运的是，一旦您连接到主机，您还可以通过从命令面板 (F1, ⇧⌘P (Windows, Linux Ctrl+Shift+P)) 运行 首选项: 打开远程设置 命令，或通过在设置编辑器中选择远程选项卡来设置主机特定设置。每当您连接到主机时，这些设置都将覆盖您现有的任何用户设置。工作区设置将覆盖远程和用户设置。

Host-specific settings tab

使用本地工具

远程 - SSH 扩展不直接支持同步源代码或使用本地工具处理远程主机上的内容。但是，有两种方法可以使用适用于大多数 Linux 主机的常用工具来完成此操作。具体来说，您可以：

SSHFS 是最便捷的选项，不需要任何文件同步。但是，性能将明显低于通过 VS Code 工作，因此最好用于单个文件编辑以及内容的上传/下载。如果您需要使用一个一次性读取/写入大量文件的应用程序（例如本地源代码管理工具），则 rsync 是更好的选择。

已知限制

远程 - SSH 限制

建议使用基于密钥的身份验证。为备用身份验证方法输入的密码和其他令牌不会保存。
不支持 Alpine Linux 和非 glibc 的 Linux SSH 主机。
较旧的（社区支持的）Linux 发行版需要变通方法才能安装所需的先决条件。
Windows 上不支持 PuTTY。
如果您使用 SSH 克隆 Git 仓库，并且您的 SSH 密钥有密码短语，那么 VS Code 的拉取和同步功能在远程运行时可能会挂起。请使用没有密码短语的 SSH 密钥，使用 HTTPS 克隆，或从命令行运行 git push 以解决此问题。
本地代理设置在远程主机上不会被重用，这可能会阻止扩展工作，除非在远程主机上配置了适当的代理信息（例如带有适当代理信息的全局 HTTP_PROXY 或 HTTPS_PROXY 环境变量）。
有关与 SSH 相关的活动问题列表，请参阅此处。

容器工具扩展限制

如果您正在从 WSL、远程 - 隧道或远程 - SSH 窗口使用容器工具或 Kubernetes 扩展，在容器资源管理器或 Kubernetes 视图中使用 附上 Visual Studio Code 上下文菜单操作将要求第二次从可用容器中选择。

扩展限制

许多扩展无需修改即可在远程 SSH 主机上工作。但是，在某些情况下，某些功能可能需要更改。如果您遇到扩展问题，此处有常见问题和解决方案的摘要，您可以在报告问题时向扩展作者提及。

此外，某些安装在 ARMv7l (AArch32) / ARMv8l (AArch64) 设备上的扩展可能由于扩展中的本机模块或运行时仅支持 x86_64 而无法工作。在这些情况下，扩展需要选择支持这些平台，通过为 ARMv7l / ARMv8l 编译/包含二进制文件。

常见问题

我如何在...上设置 SSH 客户端？

请参阅安装受支持的 SSH 客户端了解详细信息。

我如何在...上设置 SSH 服务器？

有关为您的主机设置 SSH 服务器的详细信息，请参阅安装受支持的 SSH 服务器。

是的，您应该会自动收到输入令牌或密码的提示。但是，密码不会保存，因此使用基于密钥的身份验证通常更方便。

如何修复 SSH 错误“bad permissions”？

有关解决此类错误的详细信息，请参阅修复 SSH 文件权限错误。

远程 SSH 主机上需要安装哪些 Linux 包/库？

大多数 Linux 发行版不需要额外的依赖项安装步骤。对于 SSH，Linux 主机需要安装 Bash (/bin/bash)、tar，以及 curl 或 wget，这些实用程序可能在某些精简发行版中缺失。远程开发还需要内核 >= 3.10、glibc >=2.17、libstdc++ >= 3.4.18。目前仅支持基于 glibc 的发行版，因此 Alpine Linux 不受支持。

有关详细信息，请参阅Linux 先决条件。

VS Code Server 在远程机器/虚拟机上运行时有哪些连接要求？

安装 VS Code Server 要求您的本地机器与以下地址具备出站 HTTPS（端口 443）连接：

update.code.visualstudio.com
vscode.blob.core.windows.net
*.vo.msecnd.net (Azure CDN)

默认情况下，远程 - SSH 将尝试在远程主机上下载，并在连接建立后回退到本地下载 VS Code Server 并将其远程传输。您可以使用remote.SSH.localServerDownload 设置来更改此行为，使其始终在本地下载然后传输，或从不进行本地下载。

您可以使用 扩展: 从 VSIX 安装... 命令手动安装没有互联网连接的扩展，但如果您使用扩展面板安装扩展，您的本地机器和 VS Code 服务器需要出站 HTTPS（端口 443）访问：

marketplace.visualstudio.com
*.vo.msecnd.net (Azure CDN)
*.gallerycdn.vsassets.io (Azure CDN)

最后，一些扩展（如 C#）会从 download.microsoft.com 或 download.visualstudio.microsoft.com 下载次要依赖项。其他扩展（如 Visual Studio Live Share）可能具有额外的连接要求。如果您遇到问题，请查阅扩展的文档以获取详细信息。

服务器和 VS Code 客户端之间的所有其他通信均通过经过身份验证的安全 SSH 隧道完成。

我可以在远程 SSH 主机上的源代码上使用本地工具吗？

可以。通常通过使用 SSHFS或使用 rsync 在本地机器上获取文件副本。SSHFS 挂载远程文件系统非常适合需要编辑单个文件或浏览源代码树的场景，并且无需同步步骤即可使用。但是，它不适合使用像源代码管理工具这样批量管理文件的工具。在这种情况下，rsync 方法更好，因为您可以在本地机器上获得远程源代码的完整副本。有关详细信息，请参阅提示和技巧。

如果我只能通过 SFTP/FTP 文件系统访问远程主机（没有 shell 访问权限），我可以使用 VS Code 吗？

某些云平台仅为开发者提供远程文件系统访问，而非直接的 shell 访问。VS Code 远程开发并非针对此类用例设计，因为它会抵消性能和用户体验方面的优势。

然而，这种用例通常可以通过结合 SFTP 等扩展与 Node.js、Python、C# 或其他语言的远程调试功能来处理。

作为扩展作者，我需要做什么？

VS Code 扩展 API 抽象了本地/远程细节，因此大多数扩展无需修改即可工作。但是，鉴于扩展可以使用任何它们想要的 Node 模块或运行时，在某些情况下可能需要进行调整。我们建议您测试您的扩展，以确保不需要更新。有关详细信息，请参阅支持远程开发。

问题或反馈

请参阅提示和技巧或常见问题。
在 Stack Overflow 上搜索。
添加功能请求或报告问题。
为我们的文档或VS Code 本身做出贡献。
有关详细信息，请参阅我们的贡献指南。

06/12/2025