在 VS Code 中尝试！

在 WSL 中开发

Visual Studio Code WSL 扩展允许您直接在 VS Code 中使用 Windows Subsystem for Linux (WSL) 作为您的全职开发环境。您可以在基于 Linux 的环境中进行开发，使用 Linux 特定的工具链和实用程序，并在 Windows 的便利环境下运行和调试您的基于 Linux 的应用程序。

该扩展直接在 WSL 中运行命令和其他扩展，这样您就可以编辑位于 WSL 或挂载的 Windows 文件系统（例如 /mnt/c）中的文件，而无需担心路径问题、二进制兼容性或其他跨操作系统挑战。该扩展将在 WSL 中安装 VS Code 服务器；该服务器独立于 WSL 中任何现有的 VS Code 安装。

WSL Architecture

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

入门

注意：阅读本主题后，您可以从介绍性 WSL 教程开始。

安装

要开始使用，您需要

  1. 安装 Windows Subsystem for Linux 以及您首选的 Linux 发行版。

    注意： 对于某些类型的开发，WSL 1 确实存在一些已知限制。此外，由于扩展中原生源代码中的 glibc 依赖项，安装在 Alpine Linux 中的扩展可能无法工作。有关详细信息，请参阅远程开发和 Linux 文章。

  2. 在 Windows 端（而不是在 WSL 中）安装 Visual Studio Code。

    注意： 在安装过程中，当提示您选择附加任务时，请务必选中添加到 PATH 选项，以便您可以使用 code 命令轻松地在 WSL 中打开文件夹。

  3. 安装 WSL 扩展。如果您计划在 VS Code 中使用其他远程扩展，可以选择安装远程开发扩展包。

打开远程文件夹或工作区

从 WSL 终端

在 VS Code 中打开 Windows Subsystem for Linux 中的文件夹与从命令提示符或 PowerShell 打开 Windows 文件夹非常相似。

  1. 打开一个 WSL 终端窗口（使用开始菜单项或从命令提示符/PowerShell 输入 wsl）。

  2. 导航到您想在 VS Code 中打开的文件夹（包括但不限于 Windows 文件系统挂载，例如 /mnt/c）。

  3. 在终端中输入 code .。首次执行此操作时，您应该看到 VS Code 正在获取在 WSL 中运行所需的组件。这只需要很短的时间，并且只需要一次。

    注意： 如果此命令不起作用，您可能需要重新启动终端，或者在安装 VS Code 时未将其添加到 PATH。

  4. 片刻之后，将出现一个新的 VS Code 窗口，并且您会看到一条通知，表明 VS Code 正在 WSL 中打开该文件夹。

    WSL Starting notification

    VS Code 现在将继续在 WSL 中配置自身，并在进行过程中为您提供最新信息。

  5. 完成后，您现在将在左下角看到 WSL 指示器，并且可以像往常一样使用 VS Code 了！

    WSL Status Bar Item

就是这样！您在此窗口中执行的任何 VS Code 操作都将在 WSL 环境中执行，从编辑和文件操作，到调试、使用终端等等，无所不包。

从 VS Code 中

另外，您可以直接从 VS Code 打开一个 WSL 窗口

  1. 启动 VS Code。
  2. 按下 F1，选择 WSL: Connect to WSL 连接到默认发行版，或选择 WSL: Connect to WSL using Distro 连接到指定发行版。
  3. 使用“文件”菜单打开您的文件夹。

如果您已打开一个文件夹，也可以使用 WSL: Reopen Folder in WSL 命令。系统将提示您选择要使用的发行版。

如果您在 WSL 窗口中并想在本地窗口中打开当前输入，请使用 WSL: Reopen in Windows。

从 Windows 命令提示符

要直接从 Windows 提示符打开 WSL 窗口，请使用 --remote 命令行参数。

code --remote wsl+<发行版名称> <WSL 中的路径>

例如：code --remote wsl+Ubuntu /home/jim/projects/c

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

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

code --folder-uri vscode-remote://wsl+Ubuntu/home/ubuntu/folder.with.dot

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

code --file-uri vscode-remote://wsl+Ubuntu/home/ubuntu/fileWithoutExtension

使用 Git

如果您在 WSL 和 Windows 中使用同一存储库，请务必设置一致的行尾符。有关详细信息，请参阅技巧与窍门。

您还可以通过配置 WSL 使用 Windows Git 凭据管理器来避免密码。有关详细信息，请参阅技巧与窍门。

管理扩展

VS Code 在两个位置之一运行扩展：在 UI/客户端本地运行，或在 WSL 中运行。虽然影响 VS Code UI 的扩展（如主题和代码片段）是安装在本地的，但大多数扩展将位于 WSL 内部。

如果您从“扩展”视图安装扩展，它将自动安装到正确的位置。安装后，您可以根据类别分组来判断扩展安装在哪里。将有一个本地 - 已安装类别和一个 WSL 类别。

Workspace Extension Category

Local Extension Category

注意： 如果您是扩展作者，并且您的扩展无法正常工作或安装在错误的位置，请参阅支持远程开发以获取详细信息。

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

Disabled Extensions w/Install Button

您还可以通过转到“扩展”视图，并使用本地 - 已安装标题栏右侧的云按钮选择 Install Local Extensions in WSL: {Name} 来在 WSL 内部安装所有本地安装的扩展。这将显示一个下拉列表，您可以在其中选择要在 WSL 实例中安装的哪些本地已安装扩展。

Install all extensions

在 WSL 中打开终端

从 VS Code 在 WSL 中打开终端很简单。一旦在 WSL 中打开文件夹，您在 VS Code 中打开的任何终端窗口（终端 > 新终端）将自动在 WSL 中运行，而不是在本地运行。

您还可以从同一个终端窗口使用 code 命令行执行多项操作，例如在 WSL 中打开新文件或文件夹。键入 code --help 查看命令行上可用的选项。

Using the code CLI

在 WSL 中调试

在 WSL 中打开文件夹后，您可以使用 VS Code 的调试器，其方式与在本地运行应用程序时相同。例如，如果您在 launch.json 中选择一个启动配置并开始调试（F5），应用程序将在远程主机上启动并将调试器附加到其上。

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

WSL 特定设置

在 WSL 中打开文件夹时，VS Code 的本地用户设置也会被重用。虽然这可以保持您的用户体验一致，但您可能希望在本地计算机和 WSL 之间更改其中一些设置。幸运的是，连接到 WSL 后，您还可以通过从命令面板 (F1) 运行 Preferences: Open Remote Settings 命令或在设置编辑器中选择远程选项卡来设置 WSL 特定设置。每当您在 WSL 中打开文件夹时，这些设置将覆盖您的所有本地设置。

高级：环境设置脚本

当 VS Code Remote 在 WSL 中启动时，不会运行 shell 启动脚本。这样做是为了避免针对 shell 调整的启动脚本出现问题。如果您想运行其他命令或修改环境，可以在设置脚本 ~/.vscode-server/server-env-setup（Insiders 版本：~/.vscode-server-insiders/server-env-setup）中完成。如果存在，该脚本将在服务器启动前进行处理。

该脚本需要是一个有效的 Bourne shell 脚本。请注意，无效的脚本将阻止服务器启动。如果您编写的脚本阻止了服务器启动，则必须使用常规的 WSL shell 并删除或重命名设置脚本。

查看 WSL 日志（WSL: Show Log）以获取输出和错误。

高级：在容器中打开 WSL 2 文件夹

如果您正在使用 WSL 2 和 Docker Desktop 的 WSL 2 后端，您可以使用开发容器扩展来处理存储在 WSL 中的源代码！只需按照以下步骤操作：

  1. 如果您尚未这样做，请安装并设置 Docker Desktop 的 WSL 2 支持。

    提示： 转到设置 > 资源 > WSL 集成，并为您将使用的 WSL 发行版启用 Docker 集成。

  2. 如果您尚未这样做，请安装 开发容器 扩展以及 WSL 扩展。

  3. 接下来，像往常一样在 WSL 中打开您的源代码文件夹。

  4. 在 WSL 中打开文件夹后，从命令面板 (F1) 中选择 Dev Containers: Reopen in Container。

  5. 如果文件夹中没有 .devcontainer/devcontainer.json 文件，系统将要求您从可过滤列表中选择一个起点，或者选择现有的 Dockerfile 或 Docker Compose 文件（如果存在）。

    Select a node dev container definition

  6. VS Code 窗口（实例）将重新加载并开始构建开发容器。进度通知会提供状态更新。

    Dev Container Progress Notification

  7. 构建完成后，VS Code 将自动连接到容器。您现在可以在容器内部处理您的源代码了。

有关更多信息，请参阅开发容器文档。

已知限制

本节包含 WSL 的常见已知问题列表。目的不是提供完整的已知问题列表，而是突出显示使用 WSL 时遇到的一些常见问题。

请参阅此处，了解与 WSL 相关的所有活动问题列表。

在 WSL 1 中尝试重命名打开的工作区中的文件夹时看到 EACCES: 权限被拒绝错误

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

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

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

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

WSL 1 中的 Golang

问题 现有问题
Delve 调试器在 WSL 下无法工作 go-delve/delve#810, Microsoft/vscode-go#926

WSL 1 中的 Node.js

问题 现有问题
NodeJS 错误：spawn EACCES（此错误的不同变体） Microsoft/WSL#3886
Webpack HMR 不工作 Microsoft/WSL#2709
通过 node 方式访问 Firebase 在 WSL 中异常缓慢 Microsoft/WSL#2657

Git 限制

如果您使用 SSH 克隆 Git 存储库且您的 SSH 密钥有密码，则 VS Code 的拉取和同步功能在远程运行时可能会挂起。您可以选择使用不带密码的 SSH 密钥，使用 HTTPS 克隆，或从命令行运行 git push 以解决此问题。

Docker 扩展限制

虽然 Docker 扩展可以在远程和本地运行，但如果它已安装在本地，您将无法在远程 SSH 主机上安装它，除非先在本地卸载它。我们将在未来的 VS Code 版本中解决此问题。

扩展限制

许多扩展无需修改即可在 WSL 中工作。但是，在某些情况下，某些功能可能需要更改。如果您遇到扩展问题，请参阅此处，了解可在向扩展作者报告问题时提及的常见问题和解决方案摘要。

此外，由于扩展内部原生代码中存在 glibc 依赖项，在使用基于 Alpine Linux 的发行版时，安装在 WSL 中的某些扩展可能无法工作。有关详细信息，请参阅使用 Linux 进行远程开发文章。

常见问题

为什么我会被要求更改默认发行版？

使用 WSL: Connect to WSL using Distro 并在早于 Windows 10, 2019 年 5 月更新（版本 1903）的 WSL 上运行时，系统将要求您切换默认发行版，因为 WSL 命令目前只能在默认发行版上工作，因为它尚不支持 -d 选项。

您始终可以使用 wslconfig.exe 手动切换默认发行版。

例如

wslconfig /setdefault Ubuntu

您可以使用以下命令查看已安装的发行版：

wslconfig /l

我看到有关缺少库或依赖项的错误

某些扩展依赖于某些 WSL Linux 发行版的纯净安装中不存在的库。您可以通过使用其包管理器将额外的库添加到您的 Linux 发行版中。对于基于 Ubuntu 和 Debian 的发行版，运行 sudo apt-get install <package> 来安装所需的库。请检查您的扩展文档或提及的运行时，以获取其他安装详细信息。

WSL 扩展的连接要求是什么？

WSL 扩展和 VS Code 服务器需要出站 HTTPS（端口 443）连接到：

  • update.code.visualstudio.com
  • marketplace.visualstudio.com
  • vscode.blob.core.windows.net
  • *.vo.msecnd.net (Azure CDN)
  • *.gallerycdn.vsassets.io (Azure CDN)

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

服务器和 VS Code 客户端之间的所有其他通信都是通过随机本地 TCP 端口完成的。您可以在网络连接文章中找到 VS Code 本身需要访问的位置列表。

我在使用代理，并且遇到连接问题

Windows 或 WSL 端可能缺少代理设置。

当从 VSCode 外部打开远程窗口时，WSL 扩展会尝试在 Windows 端下载 VSCode 服务器。因此，它使用 Windows 端的代理配置：

从 WSL 终端启动远程 VSCode 时，下载是使用 WSL 发行版中的 wget 完成的。代理设置可以在以下位置配置：

一旦服务器启动并运行，将使用远程选项卡上的代理设置。

我可以强制扩展在本地/远程运行吗？

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

例如，以下设置将强制 Docker 扩展在本地运行，以及强制 Remote - SSH: Editing Configuration Files 扩展在远程运行，而不是使用它们的默认行为。

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

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

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

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

问题或反馈

05/08/2025