远程开发技巧

本文介绍了 Visual Studio Code 远程开发扩展的故障排除技巧。 有关设置和使用每个特定扩展的详细信息，请参阅 SSH、容器和 WSL 文章。 或者，尝试入门 教程，以帮助你快速在远程环境中运行。

有关 GitHub Codespaces 的技巧和问题，请参阅 GitHub Codespaces 文档。

SSH 技巧

SSH 功能强大且灵活，但也增加了一些设置的复杂性。 本节包含一些技巧和窍门，用于在不同的环境中启动并运行 Remote - SSH 扩展。

配置基于密钥的身份验证

SSH 公钥身份验证是一种方便、高安全性的身份验证方法，它将本地“私钥”与您在 SSH 主机上与您的用户帐户关联的“公钥”相结合。 本节将引导您完成如何生成这些密钥并将它们添加到主机。

提示：适用于 Windows 的 PuTTY 不是支持的客户端，但您可以转换您的 PuTTYGen 密钥。

快速入门：使用 SSH 密钥

要为远程主机设置基于 SSH 密钥的身份验证。 首先，我们将创建一个密钥对，然后将公钥复制到主机。

创建本地 SSH 密钥对

检查您的本地计算机上是否已存在 SSH 密钥。 它通常位于 macOS / Linux 上的 ~/.ssh/id_ed25519.pub 和 Windows 上用户配置文件文件夹中的 .ssh 目录中（例如，C:\Users\your-user\.ssh\id_ed25519.pub）。

如果您没有密钥，请在本地终端/PowerShell 中运行以下命令来生成 SSH 密钥对

ssh-keygen -t ed25519 -b 4096

提示：没有 ssh-keygen？ 安装受支持的 SSH 客户端。

限制私钥文件的权限

• 对于 macOS / Linux，请运行以下 shell 命令，必要时替换为您的私钥路径

  chmod 400 ~/.ssh/id_ed25519
  

• 对于 Windows，请在 PowerShell 中运行以下命令，以向您的用户名授予显式读取权限

  icacls "privateKeyPath" /grant <username>:R
  

  然后，在 Windows 资源管理器中导航到私钥文件，右键单击并选择“属性”。 选择“安全”选项卡 > “高级”> “禁用继承”> “从此对象删除所有继承的权限”。

授权您的 macOS 或 Linux 计算机进行连接

在本地终端窗口中运行以下命令之一，根据需要替换用户名和主机名，将您的本地公钥复制到 SSH 主机。

• 连接到 macOS 或 Linux SSH 主机

  export USER_AT_HOST="your-user-name-on-host@hostname"
  export PUBKEYPATH="$HOME/.ssh/id_ed25519.pub"
  
  ssh-copy-id -i "$PUBKEYPATH" "$USER_AT_HOST"
  

• 连接到 Windows SSH 主机

  • 该主机使用 OpenSSH 服务器，并且该用户属于管理员组

    export USER_AT_HOST="your-user-name-on-host@hostname"
    export PUBKEYPATH="$HOME/.ssh/id_ed25519.pub"
    
    ssh $USER_AT_HOST "powershell Add-Content -Force -Path \"\$Env:PROGRAMDATA\\ssh\\administrators_authorized_keys\" -Value '$(tr -d '\n\r' < "$PUBKEYPATH")'"
    

  • 否则

    export USER_AT_HOST="your-user-name-on-host@hostname"
    export PUBKEYPATH="$HOME/.ssh/id_ed25519.pub"
    
    ssh $USER_AT_HOST "powershell New-Item -Force -ItemType Directory -Path \"\$HOME\\.ssh\"; Add-Content -Force -Path \"\$HOME\\.ssh\\authorized_keys\" -Value '$(tr -d '\n\r' < "$PUBKEYPATH")'"
    

    您可能需要验证 SSH 主机上的远程用户的 .ssh 文件夹中的 authorized_keys 文件是否归您所有，并且没有其他用户有权访问它。 有关详细信息，请参阅 OpenSSH wiki。

授权您的 Windows 计算机进行连接

在本地 PowerShell 窗口中运行以下命令之一，根据需要替换用户名和主机名，将您的本地公钥复制到 SSH 主机。

• 连接到 macOS 或 Linux SSH 主机

  $USER_AT_HOST="your-user-name-on-host@hostname"
  $PUBKEYPATH="$HOME\.ssh\id_ed25519.pub"
  
  $pubKey=(Get-Content "$PUBKEYPATH" | Out-String); ssh "$USER_AT_HOST" "mkdir -p ~/.ssh && chmod 700 ~/.ssh && echo '${pubKey}' >> ~/.ssh/authorized_keys && chmod 600 ~/.ssh/authorized_keys"
  

• 连接到 Windows SSH 主机

  • 该主机使用 OpenSSH 服务器，并且该用户属于管理员组

    $USER_AT_HOST="your-user-name-on-host@hostname"
    $PUBKEYPATH="$HOME\.ssh\id_ed25519.pub"
    
    Get-Content "$PUBKEYPATH" | Out-String | ssh $USER_AT_HOST "powershell `"Add-Content -Force -Path `"`$Env:PROGRAMDATA\ssh\administrators_authorized_keys`" `""
    

  • 否则

    $USER_AT_HOST="your-user-name-on-host@hostname"
    $PUBKEYPATH="$HOME\.ssh\id_ed25519.pub"
    
    Get-Content "$PUBKEYPATH" | Out-String | ssh $USER_AT_HOST "powershell `"New-Item -Force -ItemType Directory -Path `"`$HOME\.ssh`"; Add-Content -Force -Path `"`$HOME\.ssh\authorized_keys`" `""
    

    验证 SSH 主机上的远程用户的 .ssh 文件夹中的 authorized_keys 文件是否归您所有，并且没有其他用户有权访问它。 有关详细信息，请参阅 OpenSSH wiki。

通过专用密钥提高安全性

虽然在所有 SSH 主机上使用单个 SSH 密钥可能很方便，但如果任何人获得对您的私钥的访问权限，他们也将获得对您所有主机的访问权限。 您可以通过为您的开发主机创建单独的 SSH 密钥来防止这种情况。 只需按照以下步骤操作

1. 在不同的文件中生成单独的 SSH 密钥。

   macOS / Linux：在本地终端中运行以下命令

   ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519-remote-ssh
   

   Windows：在本地 PowerShell 中运行以下命令

   ssh-keygen -t ed25519 -f "$HOME\.ssh\id_ed25519-remote-ssh"
   

2. 按照快速入门中的相同步骤，在 SSH 主机上授权密钥，但将 PUBKEYPATH 设置为 id_ed25519-remote-ssh.pub 文件。

3. 在 VS Code 中，在命令面板 ( F1 ) 中运行 Remote-SSH：打开配置文件... ，选择 SSH 配置文件，并添加（或修改）主机条目，如下所示

   Host name-of-ssh-host-here
       User your-user-name-on-host
       HostName host-fqdn-or-ip-goes-here
       IdentityFile ~/.ssh/id_ed25519-remote-ssh
   

   提示：您也可以对 Windows 路径使用 /。 如果您使用 \，则需要使用两个斜杠。 例如，C:\\path\\to\\my\\id_ed25519。

重用在 PuTTYGen 中生成的密钥

如果您使用 PuTTYGen 为您连接的主机设置了 SSH 公钥身份验证，您需要转换您的私钥，以便其他 SSH 客户端可以使用它。要执行此操作，请执行以下步骤：

1. 在本地打开 PuTTYGen 并加载您要转换的私钥。

2. 从应用程序菜单中选择“Conversions > Export OpenSSH key”。将转换后的密钥保存到您的用户配置文件文件夹中 .ssh 目录下的一个本地位置（例如 C:\Users\youruser\.ssh）。

3. 验证这个新的本地文件是否归您所有，并且没有其他用户有权访问它。

4. 在 VS Code 中，在命令面板（F1）中运行“Remote-SSH: Open Configuration File...”，选择您要更改的 SSH 配置文件，并按如下方式在配置文件中添加（或修改）主机条目以指向该文件：

   Host name-of-ssh-host-here
       User your-user-name-on-host
       HostName host-fqdn-or-ip-goes-here
       IdentityFile ~/.ssh/exported-keyfile-from-putty
   

提高多用户服务器的安全性

Remote - SSH 扩展会安装并维护“VS Code Server”。服务器以随机生成的密钥启动，任何与服务器的新连接都需要提供该密钥。该密钥存储在远程磁盘上，只能由当前用户读取。有一个 HTTP 路径在 /version 处可供访问，无需身份验证。

默认情况下，服务器在随机 TCP 端口上的 localhost 上监听，然后转发到您的本地机器。如果您连接到 Linux 或 macOS 主机，您可以切换到使用锁定到特定用户的 Unix 套接字。然后转发此套接字而不是端口。

注意： 此设置会禁用连接多路复用，因此建议配置公钥身份验证。

要配置它，请执行以下操作：

1. 确保您在 Windows、macOS 或 Linux 上有一个本地 OpenSSH 6.7+ SSH 客户端，以及一个 OpenSSH 6.7+ Linux 或 macOS 主机（Windows 不支持此模式）。

2. 通过在您的本地 VS Code 用户设置中启用 Remote.SSH: Remote Server Listen On Socket，将 Remote - SSH 切换到套接字模式。

   

3. 如果您已经连接到 SSH 主机，请从命令面板（F1）中选择“Remote-SSH: Kill VS Code Server on Host...”，以便设置生效。

如果在连接时遇到错误，您可能需要在 SSH 主机的 sshd 配置上启用套接字转发。要执行此操作，请执行以下操作：

1. 在SSH 主机（而不是本地）上，在文本编辑器（如 vi、nano 或 pico）中打开 /etc/ssh/sshd_config。
2. 添加设置 AllowStreamLocalForwarding yes。
3. 重新启动 SSH 服务器。（在 Ubuntu 上，运行 sudo systemctl restart sshd。）
4. 重试。

排查挂起或连接失败的问题

如果在尝试连接时遇到 VS Code 挂起（并可能超时）的问题，您可以尝试执行以下几项操作来解决此问题。

常规故障排除：删除服务器

一个有助于排查各种 Remote-SSH 问题的命令是“Remote-SSH: Kill VS Code Server on Host”。这将删除服务器，这可以修复您可能看到的一系列问题和错误消息，例如“Could not establish connection to server_name: The VS Code Server failed to start.”。

查看 VS Code 是否在等待提示

在 VS Code 中启用 remote.SSH.showLoginTerminal 设置并重试。如果提示您输入密码或令牌，请参阅启用备用 SSH 身份验证方法以了解有关减少提示频率的详细信息。

如果您仍然遇到问题，请在 settings.json 中设置以下属性并重试：

"remote.SSH.showLoginTerminal": true,
"remote.SSH.useLocalServer": false

解决某些 Windows OpenSSH 服务器版本中的错误

由于某些 Windows OpenSSH 服务器版本中的错误，用于确定主机是否正在运行 Windows 的默认检查可能无法正常工作。使用 Windows 1909 及更低版本附带的 OpenSSH 服务器不会发生这种情况。

幸运的是，您可以通过在 settings.json 中添加以下内容来专门告诉 VS Code 您的 SSH 主机是否正在运行 Windows，从而解决此问题：

"remote.SSH.useLocalServer": false

您还可以使用以下属性强制 VS Code 将特定主机标识为 Windows：

"remote.SSH.remotePlatform": {
    "host-in-ssh-config-or-fqdn": "windows"
}

已合并修复程序，因此此问题应在大于 8.1.0.0 的服务器版本中得到解决。

在远程主机上启用 TCP 转发

Remote - SSH 扩展使用 SSH 隧道来促进与主机的通信。在某些情况下，这可能在您的 SSH 服务器上被禁用。要查看这是否是问题所在，请打开输出窗口中的“Remote - SSH”类别，并检查以下消息：

open failed: administratively prohibited: open failed

如果您看到该消息，请按照以下步骤更新 SSH 服务器的 sshd 配置：

1. 在SSH 主机（而不是本地）上，在文本编辑器（如 Vim、nano、Pico 或记事本）中打开 /etc/ssh/sshd_config 或 C:\ProgramData\ssh\sshd_config。
2. 添加设置 AllowTcpForwarding yes。
3. 重新启动 SSH 服务器。（在 Ubuntu 上，运行 sudo systemctl restart sshd。在 Windows 上，在管理员 PowerShell 中运行 Restart-Service sshd。）
4. 重试。

在 SSH 配置文件中设置 ProxyCommand 参数

如果您在代理后面并且无法连接到 SSH 主机，您可能需要在本地SSH 配置文件中使用主机的 ProxyCommand 参数。您可以阅读此 SSH ProxyCommand 文章，了解其用法的示例。

确保远程计算机具有 Internet 访问权限

远程计算机必须具有 Internet 访问权限，才能从 Marketplace 下载 VS Code Server 和扩展。请参阅 FAQ，了解有关连接要求的详细信息。

在远程主机上设置 HTTP_PROXY / HTTPS_PROXY

如果您的远程主机位于代理后面，您可能需要在 SSH 主机上设置 HTTP_PROXY 或 HTTPS_PROXY 环境变量。打开您的 ~/.bashrc 文件，添加以下内容（将 proxy.fqdn.or.ip:3128 替换为相应的主机名/IP 和端口）：

export HTTP_PROXY=http://proxy.fqdn.or.ip:3128
export HTTPS_PROXY=$HTTP_PROXY

# Or if an authenticated proxy
export HTTP_PROXY=http://username:[email protected]:3128
export HTTPS_PROXY=$HTTP_PROXY

解决 /tmp 以 noexec 挂载的问题

某些远程服务器设置为不允许从 /tmp 执行脚本。VS Code 将其安装脚本写入系统临时目录，并尝试从那里执行它。您可以与您的系统管理员合作，以确定是否可以解决此问题。

检查在安装期间是否启动了不同的 shell

某些用户在 SSH 主机上的 .bash_profile 或其他启动脚本中启动不同的 shell，因为他们想使用与默认 shell 不同的 shell。这可能会破坏 VS Code 的远程服务器安装脚本，并且不建议这样做。相反，请使用 chsh 更改远程计算机上的默认 shell。

连接到每次连接动态分配机器的系统

某些系统会在每次建立 SSH 连接时，将 SSH 连接动态路由到群集中的一个节点。对于 VS Code 来说，这是一个问题，因为它会建立两个连接来打开远程窗口：第一个连接用于安装或启动 VS Code Server（或查找已运行的实例），第二个连接用于创建 VS Code 用来与服务器通信的 SSH 端口隧道。如果在创建第二个连接时，VS Code 被路由到不同的机器，它将无法与 VS Code 服务器通信。

此问题的解决方法之一是在 OpenSSH（仅限 macOS/Linux 客户端）中使用 ControlMaster 选项，如 启用备用 SSH 身份验证方法中所述，以便 VS Code 的两个连接将通过到同一节点的单个 SSH 连接进行多路复用。

联系系统管理员以获得配置帮助

SSH 是一个非常灵活的协议，支持多种配置。如果您在登录终端或“Remote-SSH”输出窗口中看到其他错误，则可能是由于缺少设置造成的。

请联系您的系统管理员，以获取有关您的 SSH 主机和客户端所需设置的信息。连接到 SSH 主机的特定命令行参数可以添加到 SSH 配置文件中。

要访问您的配置文件，请在命令面板（F1）中运行“Remote-SSH: Open Configuration File...”。然后，您可以与管理员合作添加必要的设置。

启用备用 SSH 身份验证方法

如果您正在连接到 SSH 远程主机，并且属于以下情况之一：

• 使用双因素身份验证进行连接
• 使用密码身份验证
• 当 SSH 代理未运行或无法访问时，使用带有密码的 SSH 密钥

那么 VS Code 应该会自动提示您输入所需的信息。如果您没有看到提示，请在 VS Code 中启用 remote.SSH.showLoginTerminal 设置。此设置会在 VS Code 运行 SSH 命令时显示终端。然后，您可以在终端出现时输入您的身份验证代码、密码或密码。

如果您仍然遇到问题，您可能需要在 settings.json 中添加以下属性并重试：

"remote.SSH.showLoginTerminal": true,
"remote.SSH.useLocalServer": false

如果您在 macOS 和 Linux 上，并且想要减少输入密码或令牌的频率，您可以在您的本地计算机上启用 ControlMaster 功能，以便 OpenSSH 通过单个连接运行多个 SSH 会话。

要启用 ControlMaster，请执行以下操作：

1. 在您的 SSH 配置文件中添加如下条目：

   Host *
       ControlMaster auto
       ControlPath  ~/.ssh/sockets/%r@%h-%p
       ControlPersist  600
   

2. 然后运行 mkdir -p ~/.ssh/sockets 以创建套接字文件夹。

设置 SSH 代理

如果您正在使用带有密码的密钥连接到 SSH 主机，您应该确保 SSH 代理正在本地运行。VS Code 会自动将您的密钥添加到代理中，因此您不必每次打开远程 VS Code 窗口时都输入密码。

要验证代理是否正在运行并且可以从 VS Code 的环境中访问，请在本地 VS Code 窗口的终端中运行 ssh-add -l。您应该看到代理中的密钥列表（或者它没有密钥的消息）。如果代理未运行，请按照这些说明启动它。启动代理后，请务必重新启动 VS Code。

Windows

要在 Windows 上自动启用 SSH 代理，请启动本地管理员 PowerShell 并运行以下命令：

# Make sure you're running as an Administrator
Set-Service ssh-agent -StartupType Automatic
Start-Service ssh-agent
Get-Service ssh-agent

现在，代理将在登录时自动启动。

Linux

要在后台启动 SSH 代理，请运行：

eval "$(ssh-agent -s)"

要在登录时自动启动 SSH 代理，请将以下行添加到您的 ~/.bash_profile：

if [ -z "$SSH_AUTH_SOCK" ]; then
   # Check for a currently running instance of the agent
   RUNNING_AGENT="`ps -ax | grep 'ssh-agent -s' | grep -v grep | wc -l | tr -d '[:space:]'`"
   if [ "$RUNNING_AGENT" = "0" ]; then
        # Launch a new instance of the agent
        ssh-agent -s &> .ssh/ssh-agent
   fi
   eval `cat .ssh/ssh-agent`
fi

macOS

默认情况下，代理应在 macOS 上运行。

使本地 SSH 代理在远程可用

本地计算机上的 SSH 代理允许 Remote - SSH 扩展连接到您选择的远程系统，而无需反复提示输入密码。但是，在远程系统上运行的 Git 等工具无法访问您本地解锁的私钥。

您可以通过在远程系统上打开集成终端并运行 ssh-add -l 来验证这一点。该命令应该列出已解锁的密钥，但实际上会报告无法连接到身份验证代理的错误。设置 ForwardAgent yes 使本地 SSH 代理在远程环境中可用，从而解决此问题。

您可以通过编辑 .ssh/config 文件（或任何设置为 Remote.SSH.configFile 的文件 - 使用 Remote-SSH: 打开 SSH 配置文件... 命令来确保）并添加以下内容来实现此目的：

Host *
    ForwardAgent yes

请注意，您可能希望更加严格，仅为特定的命名主机设置此选项。

修复 SSH 文件权限错误

SSH 对文件权限要求严格，如果设置不正确，您可能会看到诸如“警告：未受保护的私钥文件！”之类的错误。 有几种方法可以更新文件权限以解决此问题，下面各节将对此进行描述。

本地 SSH 文件和文件夹权限

macOS / Linux

在您的本地计算机上，请确保设置以下权限

Windows

具体的预期权限可能因您正在使用的确切 SSH 实现而异。我们建议使用开箱即用的 Windows 10 OpenSSH 客户端。

在这种情况下，请确保 SSH 主机上远程用户的所有 .ssh 文件夹中的文件都归您所有，并且没有其他用户有权访问它。有关详细信息，请参阅 Windows OpenSSH Wiki。

对于所有其他客户端，请查阅客户端的文档，了解实现所期望的内容。

服务器 SSH 文件和文件夹权限

macOS / Linux

在您连接的远程计算机上，请确保设置以下权限

请注意，目前仅支持 Linux 主机，这就是为什么省略了 macOS 和 Windows 10 的权限的原因。

Windows

有关设置 Windows OpenSSH 服务器的相应文件权限的详细信息，请参阅 Windows OpenSSH Wiki。

安装受支持的 SSH 客户端

VS Code 将在 PATH 中查找 ssh 命令。如果找不到，在 Windows 上，它将尝试在默认的 Git for Windows 安装路径中查找 ssh.exe。您还可以通过将 remote.SSH.path 属性添加到 settings.json 来专门告诉 VS Code 在哪里找到 SSH 客户端。

安装受支持的 SSH 服务器

解决在 SSH 主机上执行 Git 推送或同步时挂起的问题

如果您使用 SSH 克隆 Git 存储库，并且您的 SSH 密钥有密码，则 VS Code 的拉取和同步功能在远程运行时可能会挂起。

可以使用不带密码的 SSH 密钥，使用 HTTPS 克隆，或从命令行运行 git push 来解决此问题。

使用 SSHFS 访问远程主机上的文件

SSHFS 是一种安全的远程文件系统访问协议，它基于 SFTP 构建。它比 CIFS / Samba 共享等方式的优势在于，它只需要对计算机的 SSH 访问权限。

注意：出于性能原因，SSHFS 最适合用于单个文件编辑和上传/下载内容。如果您需要使用一次性批量读取/写入许多文件的应用程序（例如本地源代码管理工具），则 rsync 是更好的选择。

macOS / Linux:

在 Linux 上，您可以使用发行版的包管理器来安装 SSHFS。对于 Debian/Ubuntu：sudo apt-get install sshfs

注意：WSL 1 不支持 FUSE 或 SSHFS，因此目前 Windows 的说明有所不同。 WSL 2 包含 FUSE 和 SSHFS 支持，因此这种情况很快就会改变。

在 macOS 上，您可以使用 Homebrew 安装 SSHFS

brew install --cask macfuse
brew install gromgit/fuse/sshfs-mac
brew link --overwrite sshfs-mac

此外，如果您不想使用命令行来挂载远程文件系统，您还可以安装 SSHFS GUI。

要使用命令行，请从本地终端运行以下命令（将 user@hostname 替换为远程用户和主机名/IP）

export USER_AT_HOST=user@hostname
# Make the directory where the remote filesystem will be mounted
mkdir -p "$HOME/sshfs/$USER_AT_HOST"
# Mount the remote filesystem
sshfs "$USER_AT_HOST:" "$HOME/sshfs/$USER_AT_HOST" -ovolname="$USER_AT_HOST" -p 22  \
    -o workaround=nonodelay -o transform_symlinks -o idmap=user  -C

这将使您在远程计算机上的主文件夹在 ~/sshfs 下可用。完成后，您可以使用操作系统的 Finder / 文件资源管理器或使用命令行卸载它

umount "$HOME/sshfs/$USER_AT_HOST"

Windows

请按照以下步骤操作

1. 在 Linux 上，将 .gitattributes 文件添加到您的项目中，以强制 Linux 和 Windows 之间保持一致的行尾，从而避免由于两个操作系统之间 CRLF/LF 差异而导致的意外问题。有关详细信息，请参阅 解决 Git 行尾问题。

2. 接下来，使用 Chocolatey 安装 SSHFS-Win：choco install sshfs

3. 为 Windows 安装 SSHFS 后，您可以使用文件资源管理器的“映射网络驱动器...”选项，路径为 \\sshfs\user@hostname，其中 user@hostname 是您的远程用户和主机名/IP。您可以使用命令提示符编写脚本，如下所示： net use /PERSISTENT:NO X: \\sshfs\user@hostname

4. 完成后，右键单击文件资源管理器中的驱动器，然后选择“断开连接”来断开连接。

从终端连接到远程主机

配置主机后，可以通过传递远程 URI 直接从终端连接到该主机。

例如，要连接到 remote_server 并打开 /code/my_project 文件夹，请运行

code --remote ssh-remote+remote_server /code/my_project

我们需要猜测输入路径是文件还是文件夹。如果它有文件扩展名，则被视为文件。

要强制打开文件夹，请在路径中添加斜杠或使用

code --folder-uri vscode-remote://ssh-remote+remote_server/code/folder.with.dot

要强制打开文件，请添加 --goto 或使用

code --file-uri vscode-remote://ssh-remote+remote_server/code/fileWithoutExtension

使用 rsync 来维护源代码的本地副本

除了使用 SSHFS 访问远程文件外，另一种方法是使用 rsync 将远程主机上文件夹的全部内容复制到本地计算机。rsync 命令将确定每次运行时需要更新哪些文件，这比使用 scp 或 sftp 更高效和方便。如果您真的需要使用多文件或性能密集的本地工具，主要应该考虑这一点。

rsync 命令可在 macOS 上开箱即用，并且可以使用 Linux 包管理器进行安装（例如，在 Debian/Ubuntu 上使用 sudo apt-get install rsync）。对于 Windows，您需要使用 WSL 或 Cygwin 来访问该命令。

要使用该命令，请导航到要存储同步内容的文件夹，然后运行以下命令，将 user@hostname 替换为远程用户和主机名/IP，将 /remote/source/code/path 替换为远程源代码位置。

在 macOS、Linux 或 WSL 内部

rsync -rlptzv --progress --delete --exclude=.git "user@hostname:/remote/source/code/path" .

或者使用 Windows 上的 PowerShell 中的 WSL

wsl rsync -rlptzv --progress --delete --exclude=.git "user@hostname:/remote/source/code/path" "`$(wslpath -a '$PWD')"

您可以在每次想要获取文件的最新副本时重新运行此命令，并且只会传输更新。有意排除 .git 文件夹，这既是为了性能原因，也是为了您可以使用本地 Git 工具而不必担心远程主机上的状态。

要推送内容，请反转命令中的源和目标参数。但是，在 Windows 上，您应该在执行此操作之前将 .gitattributes 文件添加到您的项目中，以强制保持一致的行尾。有关详细信息，请参阅解决 Git 行尾问题。

rsync -rlptzv --progress --delete --exclude=.git . "user@hostname:/remote/source/code/path"

清理远程主机上的 VS Code 服务器

SSH 扩展提供了一个用于从远程计算机清理 VS Code 服务器的命令：Remote-SSH：从主机卸载 VS Code 服务器...。此命令执行两项操作：它终止任何正在运行的 VS Code 服务器进程，并删除服务器的安装文件夹。

如果您想手动运行这些步骤，或者该命令对您不起作用，您可以运行如下脚本

# Kill server processes
kill -9 $(ps aux | grep vscode-server | grep $USER | grep -v grep | awk '{print $2}')
# Delete related files and folder
rm -rf $HOME/.vscode-server # Or ~/.vscode-server-insiders

VS Code 服务器先前安装在 ~/.vscode-remote 下，因此您也可以检查该位置。

通过 SSH 连接到远程 WSL 2 主机

您可能需要使用 SSH 连接到远程计算机上运行的 WSL 发行版。查看 本指南，了解如何通过 SSH 从外部计算机连接到 Windows 10 上的 Bash 和 WSL 2。

提交问题

如果您在使用 Remote-SSH 扩展时遇到问题，并认为需要提交问题，请首先确保您已阅读本网站上的文档，然后查看故障排除 Wiki 文档，获取有关如何获取日志文件以及尝试更多步骤以帮助缩小问题来源的信息。

开发容器技巧

如果您想了解有关使用开发容器的技巧，可以转到开发容器提示和技巧。

WSL 技巧

首次启动：VS Code Server 的先决条件

某些 WSL Linux 发行版缺少 VS Code 服务器启动所需的库。您可以使用其包管理器将其他库添加到您的 Linux 发行版中。

Debian 和 Ubuntu

打开 Debian 或 Ubuntu WSL Shell 以添加 wget 和 ca-certificates

sudo apt-get update && sudo apt-get install wget ca-certificates

Alpine

以 root 身份打开 Alpine WSL Shell (wsl -d Alpine -u root) 以添加 libstdc++

apk update && apk add libstdc++

在 Windows 10 2018 年 4 月更新（版本 1803）及更早版本中，需要 /bin/bash

apk update && apk add bash

选择 WSL 扩展使用的发行版

WSL：新建窗口将打开注册为默认的 WSL 发行版。

要打开非默认发行版，请从要使用的发行版的 WSL Shell 中运行 code .，或使用 WSL：使用发行版新建窗口。

对于早于 Windows 10 2019 年 5 月更新（版本 1903）的 WSL 版本，WSL 命令只能使用默认发行版。因此，如果同意更改默认发行版，WSL 扩展可能会提示您。

您始终可以使用 wslconfig.exe 来更改您的默认设置。

例如

wslconfig /setdefault Ubuntu

您可以通过运行以下命令查看已安装的发行版

wslconfig /l

配置服务器启动的环境

当 WSL 扩展在 WSL 中启动 VS Code 服务器时，它不会运行任何 Shell 配置脚本。这样做是为了避免自定义配置脚本阻止启动。

如果您需要配置启动环境，可以使用此处描述的环境设置脚本。

配置远程扩展主机的环境

远程扩展主机和终端的环境基于默认 Shell 的配置脚本。为了评估远程扩展主机进程的环境变量，服务器会创建一个默认 Shell 的实例作为交互式登录 Shell。它从中探测环境变量，并将其用作远程扩展主机进程的初始环境。因此，环境变量的值取决于配置为默认值的 Shell 以及该 Shell 的配置脚本的内容。

有关每个 Shell 的配置脚本的概述，请参阅Unix Shell 初始化。大多数 WSL 发行版都将 /bin/bash 配置为默认 Shell。/bin/bash 将首先在 /etc/profile 下查找启动文件，然后在 ~/.bash_profile、~/.bash_login、~/.profile 下查找任何启动文件。

要更改 WSL 发行版的默认 Shell，请按照此博客文章中的说明进行操作。

修复 code 命令不起作用的问题

如果在 Windows 上的 WSL 终端中键入 code 不起作用，因为找不到 code，则可能是 WSL 中 PATH 中缺少一些关键位置。

通过打开 WSL 终端并键入 echo $PATH 来检查。您应该看到 VS Code 安装路径已列出。默认情况下，这将是

/mnt/c/Users/Your Username/AppData/Local/Programs/Microsoft VS Code/bin

但是，如果您使用了系统安装程序，则安装路径为

/mnt/c/Program Files/Microsoft VS Code/bin

...或者...

/mnt/c/Program Files (x86)/Microsoft VS Code/bin

WSL 的一个特性是从 Windows 中的 PATH 变量继承路径。要更改 Windows PATH 变量，请使用 Windows 开始菜单中的编辑帐户的环境变量命令。

如果您已禁用路径共享功能，请编辑 .bashrc，添加以下内容，然后启动新终端

WINDOWS_USERNAME="Your Windows Alias"

export PATH="$PATH:/mnt/c/Windows/System32:/mnt/c/Users/${WINDOWS_USERNAME}/AppData/Local/Programs/Microsoft VS Code/bin"
# or...
# export PATH="$PATH:/mnt/c/Program Files/Microsoft VS Code/bin"
# or...
# export PATH="$PATH:/mnt/c/Program Files (x86)/Microsoft VS Code/bin"

注意：请务必引用或转义目录名称中的空格字符。

查找 'code' 命令的问题

如果在 Windows 命令提示符中键入 code 没有启动 VS Code，您可以通过运行 VSCODE_WSL_DEBUG_INFO=true code . 来帮助我们诊断问题。

请提交问题并附上完整输出。

查找启动或连接到服务器的问题

当 WSL 窗口无法连接到远程服务器时，您可以在 WSL 日志中获取更多信息。提交问题时，务必始终发送 WSL 日志的全部内容。

通过运行命令 WSL：打开日志打开 WSL 日志。日志将显示在 WSL 选项卡下的终端视图中。

要获得更详细的日志记录，请在用户设置中启用设置 remote.WSL.debug。

服务器无法启动并出现段错误

您可以通过向我们发送核心转储文件来帮助我们调查此问题。要获取核心转储文件，请按照以下步骤操作

在 Windows 命令提示符中

• 运行 code --locate-extension ms-vscode-remote.remote-wsl 以确定 WSL 扩展文件夹。
• cd 到返回的路径。
• 使用 VS Code 打开 wslServer.sh 脚本，code .\scripts\wslServer.sh。
• 在最后一行之前（在 "$VSCODE_REMOTE_BIN/$COMMIT/bin/$SERVER_APPNAME" "$@" 之前），添加 ulimit -C unlimited。
• 启动运行远程服务器的 WSL 窗口，并等待段错误。

核心文件将在上述 WSL 扩展文件夹中。

我看到 EACCES：尝试在打开的工作区中重命名文件夹时出现权限被拒绝错误

这是 WSL 文件系统实现的已知问题（Microsoft/WSL#3395，Microsoft/WSL#1956），由 VS Code 激活的文件监视器引起。此问题仅在 WSL 2 中得到修复。

要避免此问题，请将 remote.WSL.fileWatcher.polling 设置为 true。但是，基于轮询的方式会对大型工作区产生性能影响。

对于大型工作区，您可能需要增加轮询间隔 remote.WSL.fileWatcher.pollingInterval，并使用 files.watcherExclude 控制监视的文件夹。

WSL 2 没有该文件监视器问题，并且不受新设置的影响。

解决 WSL 中 Git 行尾问题（导致许多修改后的文件）

由于 Windows 和 Linux 使用不同的默认行尾，Git 可能会报告大量修改后的文件，这些文件除了行尾之外没有其他差异。为防止这种情况发生，您可以使用 .gitattributes 文件或在 Windows 端全局禁用行尾转换。

通常，在存储库中添加或修改 .gitattributes 文件是解决此问题的最可靠方法。将此文件提交到源代码控制将有助于其他人，并允许您根据需要按存储库更改行为。例如，将以下内容添加到存储库根目录下的 .gitattributes 文件中将强制所有内容都为 LF，但需要 CRLF 的 Windows 批处理文件除外

* text=auto eol=lf
*.{cmd,[cC][mM][dD]} text eol=crlf
*.{bat,[bB][aA][tT]} text eol=crlf

请注意，这适用于 Git v2.10+，因此，如果您遇到问题，请确保您已安装了最新的 Git 客户端。您可以将存储库中需要 CRLF 的其他文件类型添加到同一文件中。

如果您仍然希望始终上传 Unix 样式的行尾 (LF)，可以使用 input 选项。

git config --global core.autocrlf input

如果您希望完全禁用行尾转换，请改为运行以下命令

git config --global core.autocrlf false

最后，您可能需要重新克隆存储库才能使这些设置生效。

在 Windows 和 WSL 之间共享 Git 凭据

如果您使用 HTTPS 克隆存储库并且在 Windows 中配置了凭据助手，则可以将其与 WSL 共享，以便您输入的密码在两侧都保留。（请注意，这不适用于使用 SSH 密钥。）

只需按照以下步骤操作

1. 通过在 Windows 命令提示符或 PowerShell 中运行以下命令，在 Windows 上配置凭据管理器

    git config --global credential.helper wincred
   

2. 配置 WSL 以使用相同的凭据助手，但在 WSL 终端中运行以下命令

    git config --global credential.helper "/mnt/c/Program\ Files/Git/mingw64/bin/git-credential-manager-core.exe"
   

现在，您在 Windows 端使用 Git 时输入的任何密码都可用于 WSL，反之亦然。

解决从 WSL 进行 Git 推送或同步时挂起的问题

如果您使用 SSH 克隆 Git 存储库，并且您的 SSH 密钥有密码，则 VS Code 的拉取和同步功能在远程运行时可能会挂起。

可以使用不带密码的 SSH 密钥，使用 HTTPS 克隆，或从命令行运行 git push 来解决此问题。

GitHub Codespaces 技巧

有关 GitHub Codespaces 的提示和问题，请参阅 GitHub Codespaces 文档。您还可以查看可能会影响您的 Codespaces 的已知的 Web 限制和调整。

扩展技巧

虽然许多扩展程序在未经修改的情况下都可以正常工作，但有一些问题可能会阻止某些功能按预期工作。在某些情况下，您可以使用其他命令来解决该问题，而在其他情况下，可能需要修改扩展程序。本节提供有关常见问题以及如何解决这些问题的快速参考。您还可以参阅有关 支持远程开发的主要扩展程序文章，以获取有关修改扩展程序以支持远程扩展程序主机的深入指南。

解决有关缺少依赖项的错误

某些扩展程序依赖于某些 WSL Linux 发行版的基本安装中未找到的库。您可以使用其包管理器将其他库添加到您的 Linux 发行版中。对于基于 Ubuntu 和 Debian 的发行版，请运行 sudo apt-get install <package> 以安装所需的库。有关其他安装详细信息，请查看扩展程序或错误消息中提到的运行时的文档。

本地绝对路径设置在远程应用时失败

当您连接到远程终结点时，VS Code 的本地用户设置会被重用。虽然这可以使您的用户体验保持一致，但您可能需要在本地计算机与每个主机/容器/WSL 之间更改绝对路径设置，因为目标位置不同。

解决方案：您可以在连接到远程终结点后，通过从命令面板（F1）运行 首选项：打开远程设置命令或在设置编辑器中选择 远程 选项卡来设置特定于终结点的设置。无论何时连接，这些设置都将覆盖您已设置的任何本地设置。

需要在远程终结点上安装本地 VSIX

有时，您可能需要在远程计算机上安装本地 VSIX，无论是在开发期间还是在扩展程序作者要求您尝试修复时。

解决方案：连接到 SSH 主机、容器或 WSL 后，您可以像在本地一样安装 VSIX。从命令面板（F1）运行 扩展程序：从 VSIX 安装... 命令。您可能还需要将 "extensions.autoUpdate": false 添加到 settings.json 中，以防止自动更新到最新的 Marketplace 版本。有关在远程环境中开发和测试扩展程序的更多信息，请参阅支持远程开发。

浏览器未在本地打开

某些扩展程序使用外部节点模块或自定义代码来启动浏览器窗口。不幸的是，这可能会导致扩展程序在远程而不是本地启动浏览器。

解决方案：扩展程序可以使用 vscode.env.openExternal API 来解决此问题。有关详细信息，请参阅扩展程序作者指南。

剪贴板无法工作

一些扩展使用像 clipboardy 这样的 Node 模块来与剪贴板集成。不幸的是，这可能会导致扩展在远程端与剪贴板的集成不正确。

解决方案： 扩展可以切换到 VS Code 剪贴板 API 来解决此问题。请参阅扩展作者指南了解详情。

无法从浏览器或应用程序访问本地 Web 服务器

在容器、SSH 主机或通过 GitHub Codespaces 工作时，浏览器连接的端口可能会被阻止。

解决方案： 扩展可以使用 vscode.env.openExternal 或 vscode.env.asExternalUri API（自动转发 localhost 端口）来解决此问题。请参阅扩展作者指南了解详情。作为一种解决方法，可以使用“转发端口”命令手动执行此操作。

Webview 内容不显示

如果扩展的 Webview 内容使用 iframe 连接到本地 Web 服务器，则 Webview 连接的端口可能会被阻止。此外，如果扩展硬编码 vscode-resource:// URI 而不是使用 asWebviewUri，则内容可能不会在 Codespaces 浏览器编辑器中显示。

解决方案： 扩展可以使用 webview.asWebviewUri 来解决 vscode-resource:// URI 的问题。

如果端口被阻止，最好的方法是改为使用 webview 消息传递 API。作为一种解决方法，可以使用 vscode.env.asExternalUri 允许 Webview 从 VS Code 连接到生成的本地主机 Web 服务器。但是，目前 MicrosoftDocs/vscodespaces#11 阻止了 Codespaces 基于浏览器的编辑器（仅限）。有关此解决方法的详细信息，请参阅扩展作者指南。

本地主机端口被阻止

如果您尝试从外部应用程序连接到本地主机端口，则该端口可能会被阻止。

解决方案： VS Code 1.40 引入了一个新的 vscode.env.asExternalUri API，供扩展以编程方式转发任意端口。请参阅扩展作者指南了解详情。作为一种解决方法，您可以使用“转发端口”命令手动执行此操作。

存储扩展数据时出错

扩展可能会尝试通过查找 Linux 上的 ~/.config/Code 文件夹来持久化全局数据。该文件夹可能不存在，这可能会导致扩展抛出诸如 ENOENT: no such file or directory, open '/root/.config/Code/User/filename-goes-here 之类的错误。

解决方案： 扩展可以使用 context.globalStorageUri 或 context.storageUri 属性来解决此问题。请参阅扩展作者指南了解详情。

无法登录 / 每次连接到新端点时都必须登录

需要登录的扩展可能会使用自己的代码来持久化密钥。由于缺少依赖项，此代码可能会失败。即使成功，密钥也会远程存储，这意味着您必须为每个新端点登录。

解决方案： 扩展可以使用 SecretStorage API 来解决此问题。请参阅扩展作者指南了解详情。

不兼容的扩展阻止 VS Code 连接

如果远程主机、容器或 WSL 上安装了不兼容的扩展，我们已经看到由于不兼容而导致 VS Code 服务器挂起或崩溃的实例。如果扩展立即激活，这可能会阻止您连接并卸载该扩展。

解决方案： 按照以下步骤手动删除远程扩展文件夹

1. 对于容器，请确保您的 devcontainer.json 不再包含对故障扩展的引用。

2. 接下来，使用单独的终端/命令提示符连接到远程主机、容器或 WSL。

   • 如果是 SSH 或 WSL，请相应地连接到环境（运行 ssh 连接到服务器或打开 WSL 终端）。
   • 如果使用容器，请通过调用 docker ps -a 并在列表中查找具有正确名称的映像来识别容器 ID。如果容器已停止，请运行 docker run -it <id> /bin/sh。如果容器正在运行，请运行 docker exec -it <id> /bin/sh。

3. 连接后，运行 rm -rf ~/.vscode-server/extensions（适用于 VS Code 稳定版）和/或 rm -rf ~/.vscode-server-insiders/extensions（适用于 VS Code Insiders）以删除所有扩展。

附带或获取预构建本机模块的扩展失败

与 VS Code 扩展捆绑在一起（或动态获取）的本机模块必须使用 Electron 的 electron-rebuild 重新编译。但是，VS Code 服务器运行的是标准的（非 Electron）版本的 Node.js，这可能会导致二进制文件在远程使用时失败。

解决方案： 需要修改扩展来解决此问题。他们需要包含（或动态获取）两组二进制文件（Electron 和标准 Node.js），用于 VS Code 附带的 Node.js 中的“模块”版本，然后在激活函数中检查是否 context.executionContext === vscode.ExtensionExecutionContext.Remote 以设置正确的二进制文件。请参阅扩展作者指南了解详情。

扩展仅在非 x86_64 主机或 Alpine Linux 上失败

如果扩展在 Debian 9+、Ubuntu 16.04+ 或 RHEL / CentOS 7+ 远程 SSH 主机、容器或 WSL 上工作，但在支持的非 x86_64 主机（例如，ARMv7l）或 Alpine Linux 容器上失败，则扩展可能只包含不支持这些平台的本机代码或运行时。例如，扩展可能只包含本机模块或运行时的 x86_64 编译版本。对于 Alpine Linux，由于 Alpine Linux (musl) 和其他发行版 (glibc) 中 libc 的实现方式之间存在根本差异，因此包含的本机代码或运行时可能无法工作。

解决方案： 扩展需要通过编译/包含这些其他目标的二进制文件来选择支持这些平台。请务必注意，某些第三方 npm 模块也可能包含可能导致此问题的本机代码。因此，在某些情况下，您可能需要与 npm 模块作者合作添加其他编译目标。请参阅扩展作者指南了解详情。

由于缺少模块，扩展失败

在远程运行时，依赖于 Electron 或 VS Code 基本模块（未通过扩展 API 公开）的扩展（如果没有提供回退）可能会失败。您可能会在开发者工具控制台中看到诸如 original-fs 未找到之类的错误。

解决方案： 删除对 Electron 模块的依赖或提供回退。请参阅扩展作者指南了解详情。

无法访问/将远程工作区文件传输到本地计算机

在外部应用程序中打开工作区文件的扩展可能会遇到错误，因为外部应用程序无法直接访问远程文件。

解决方案： 如果您创建一个设计为在本地运行的“UI”扩展，则可以使用 vscode.workspace.fs API 与远程工作区文件系统进行交互。然后，您可以将其作为“工作区”扩展的依赖项，并根据需要使用命令调用它。请参阅扩展作者指南了解有关不同类型的扩展以及如何使用命令在它们之间进行通信的详细信息。

无法从扩展访问附加的设备

访问本地附加设备的扩展在远程运行时将无法连接到这些设备。

解决方案： 目前没有。我们正在研究解决此问题的最佳方法。

问题和反馈

报告问题

如果您在使用其中一个远程开发扩展时遇到问题，请务必收集正确的日志，以便我们能够帮助诊断您的问题。

每个远程扩展都有一个命令来查看其日志。

您可以使用命令面板 (F1) 中的 Remote-SSH: 显示日志 来获取 Remote - SSH 扩展日志。报告 Remote - SSH 问题时，请同时验证您是否能够从外部终端（不使用 Remote - SSH）通过 SSH 连接到您的计算机。

同样，您可以使用 Dev Containers: 显示容器日志 来获取 Dev Containers 扩展日志。

与上面两个扩展一样，您可以使用 WSL: 显示日志 来获取 WSL 扩展日志。还可以检查您的问题是否正在 WSL 存储库中进行跟踪（而不是由于 WSL 扩展引起的）。

如果您在远程使用其他扩展时遇到问题（例如，其他扩展在远程上下文中无法正确加载或安装），则最好从 远程扩展主机 输出通道（输出：聚焦到输出视图）中获取日志，然后从下拉列表中选择 日志 (远程扩展主机)。

注意：如果您只看到 日志 (扩展主机)，则它是本地扩展主机，并且远程扩展主机未启动。这是因为日志通道仅在创建日志文件后创建，因此如果远程扩展主机未启动，则不会创建远程扩展主机日志文件，并且不会在“输出”视图中显示。这仍然是有助于您在问题中包含的信息。

远程问题和反馈资源

我们有各种其他远程资源

• 请参阅远程开发常见问题解答。
• 在 Stack Overflow 上搜索。
• 添加功能请求或报告问题。