尝试在 VS Code 中使用

GitHub Codespaces

GitHub Codespaces 为所有活动提供云支持的开发环境,无论是长期项目还是评审拉取请求等短期任务。你可以通过 Visual Studio Code 或基于浏览器的编辑器来使用这些环境。

GitHub Codespaces extension

环境

环境是 GitHub Codespaces 的“后端”部分。所有与软件开发相关的计算都在这里进行:编译、调试、恢复等。当你需要开发新项目、处理新任务或评审拉取请求时,只需启动一个云托管环境,GitHub Codespaces 就会负责正确配置它。它会自动配置你项目所需的一切:源代码、运行时、编译器、调试器、编辑器、自定义 dotfile 配置、相关编辑器扩展等。

自定义

GitHub Codespaces 可以按项目完全自定义。这通过在项目仓库中包含一个 devcontainer.json 文件来实现,类似于 VS Code 开发容器的开发方式。

自定义示例包括

  • 设置要使用的基于 Linux 的操作系统。
  • 自动安装各种工具、运行时和框架。
  • 转发常用端口。
  • 设置环境变量。
  • 配置编辑器设置并安装首选扩展。

有关 codespace 特定的 devcontainer.json 设置,请参阅 配置 Codespaces 文档。

每个用户的 Dotfile 配置

Dotfile 是文件名以点号 (.) 开头的文件。它们通常包含应用程序的配置信息,并可以控制终端、编辑器、源代码管理以及各种其他工具的行为。.bashrc.gitignore.editorconfig 是开发者常用的 dotfile 示例。

在创建 codespace 时,你可以指定一个包含你的 dotfile 的 GitHub 仓库、文件的目标位置以及安装命令。

请参阅 个性化 Codespaces 文档,了解如何将你的 dotfile 配置添加到 codespace。

入门

GitHub Codespaces 的两种客户端都有入门主题。这些将帮助你快速完成登录 GitHub Codespaces、创建你的第一个 codespace 以及使用你偏好的客户端连接到它的过程。

扩展作者

VS Code 扩展 API 隐藏了大部分远程运行的实现细节,因此许多扩展无需任何修改即可在 GitHub Codespaces 环境中正常工作。但是,我们建议你在 codespace 中测试你的扩展,以确保其所有功能都按预期运行。有关详细信息,请参阅关于支持远程开发和 GitHub Codespaces 的文章。

基于浏览器的编辑器

你还可以在浏览器中获得完全免费、轻量级的 Visual Studio Code 体验。这个基于网络的编辑器让你能够安全快速地浏览 GitHub 上的源代码仓库并进行轻量级代码更改。你可以在编辑器中打开任何仓库、分支或拉取请求,该编辑器具有 VS Code 的许多功能,包括搜索和语法高亮。如果你想运行或调试代码,可以切换到云托管环境或 VS Code 桌面版。

要访问此基于浏览器的编辑器,你可以访问 github.com 上的仓库并按下.(句点键),或者将仓库的 URL 更改为 github.dev/org/repo,将 github.com 替换为 github.dev

限制:如果你在隐身模式下运行浏览器或启用了广告拦截器,则可能无法使用基于网络的编辑器。

注意:此编辑器目前处于技术预览阶段。你今天就可以试用,并通过 https://github.co/browser-editor-feedback 提供反馈。

已知限制和适配

在使用 Codespaces 特别是网页版 VS Code 时,需要牢记一些限制。其中一些限制有现成的解决方案或适配,以提供一致的开发体验。

对于一些问题(特别是键盘快捷方式或那些列出有桌面版解决方案的问题),你可以将 Codespace 安装并用作渐进式网页应用程序 (PWA)。

Installing Codespaces as PWA in Microsoft Edge

问题 原因 解决方案
在 Firefox 中,Ctrl+Shift+P 无法启动命令面板。 Ctrl+Shift+P 在 Firefox 中被保留。 使用 F1 启动命令面板。
某些默认键盘快捷方式(用于调试)在网页版中有所不同。 由于浏览器可能已经为这些键盘快捷方式注册了动作,我们调整了网页版 VS Code 的默认设置。 使用调整后的默认值。它们会显示在调试操作的工具提示上。
  • 在所有浏览器中,跳过是 Alt+F10(而不是 F10)。
  • 在 Windows 浏览器中,网页版中的单步进入是 Alt+F11(而不是 F11)。
在 macOS 的网页版或桌面版中,用于调试的 F11 不起作用。 这是一个已知且非浏览器特有的限制。更多信息可在 问题 #5102 中找到。 在 macOS 上禁用 F11 以显示桌面。
  • 转到:系统偏好设置 > 键盘 > 快捷键
  • 取消选中 显示桌面 F11 选项
网页版中,用于新建文件的 Ctrl+N 不起作用。 Ctrl+N 转而打开一个新窗口。 桌面版中,用于新建文件的 Ctrl+N 可以正常工作。
网页版中,用于关闭编辑器的 Ctrl+W 不起作用。 Ctrl+W 会关闭浏览器中的当前标签页。 桌面版中,Ctrl+W 可以正常工作。
Ctrl+Shift+B 将无法在浏览器中切换收藏夹栏。 Codespaces 会覆盖此功能并重定向到命令面板中的“构建”菜单。 目前没有解决方案。
将文件从 VS Code 拖放到 Codespace(反之亦然)不起作用。 你可以在 问题 #115535 中查看更多背景信息。 有几个选项
  • 你可以右键单击 Codespace 中的文件,将其下载到本地计算机。
  • 你可以将文件从文件浏览器拖动到你的 Codespace。
网页版不支持 Angular 应用调试。 基于浏览器运行的代码出于安全原因无法以调试模式启动另一个浏览器实例。 你有几个选项
  • 正常调试 Node.js/服务端 JavaScript。
  • 在桌面版中打开 Codespace,在这种情况下,伴侣应用 将用于启动你本地安装的 Edge 或 Chrome。
从浏览器下载没有扩展名的文件会自动添加“.txt” Chrome 和 Edge 的行为就是如此。 背景和潜在的未来解决方案可在 问题 #118436 中找到。
当你从远程(包括 Codespaces)下载文件时,可执行位等属性会被移除。 背景和潜在的未来解决方案可在 问题 #112099 中找到。 目前没有解决方案。
当你尝试从 Codespace 下载某些文件夹时,你可能会看到提示:“Your_codespace_name 无法打开此文件夹,因为它包含系统文件”。 用户代理可以自由地对敏感目录施加限制级别。更多信息请参阅 此规范Chromium 的阻止列表 除了规范和阻止列表外,没有其他解决方案。
在网页版中,手动访问 http://localhost:forwarded_port 无法从 Codespace 访问转发的端口。 这是基于 Codespaces 处理端口转发并为网页生成正确 URL 的方式。 单击端口转发通知中的链接以打开你的应用,或单击端口视图中的地球图标,两者都将提供正确生成的链接。更多信息请参阅 Codespaces 文档

某些扩展在网页版中的行为不同

扩展 问题 / 原因 解决方案
具有与浏览器快捷方式重叠的键盘快捷方式的扩展,例如使用 Ctrl+R 刷新的 Git Graph 键盘快捷方式可能与现有浏览器快捷方式重叠,例如在 Safari 中 Ctrl+R 刷新窗口。 你可以使用基于桌面的 Codespace 而不是基于网页的 Codespace 来充分利用你的键盘快捷方式。不同的浏览器也可能表现不同(你可以在 Chrome 中刷新 Git Graph)。
语言包,例如 Visual Studio Code 的日语语言包 基于网页的 Codespaces 目前不支持语言包扩展。 你可以使用基于桌面的 Codespace 来使用语言包和配置显示语言。
Bracket Pair Colorizer 2 它在浏览器中无法工作,因为它引入了一个不易修复的安装位置依赖。 使用 Bracket Pair Colorizer
浏览器调试器,例如 Firefox 调试器 需要 UI/桌面扩展主机的扩展不会在浏览器中加载。 你可以在本地 VS Code 中使用这些扩展(不连接到 Codespaces)。或者,当你的应用从 Codespace 运行时,你可以使用替代方案,例如 Chrome DevTools 来检查元素和设置断点。
用于打开浏览器的扩展,例如 在浏览器中打开 需要 UI/桌面扩展主机的扩展不会在浏览器中加载。 如果可能,请使用替代扩展,例如 Live Server
项目管理器 项目管理器依赖于同步自定义的 projects.json 文件,而这目前不支持 你可以在桌面版 Codespaces 或本地 VS Code 中使用此扩展来保存和管理你的项目,因为这些选项不需要同步自定义文件。
依赖 Chrome 的扩展,例如 Protractor Test RunnerBrowser Preview Codespace 中不包含 Chrome。 尝试寻找替代体验,或者你可以在本地 VS Code(不连接到 Codespaces)中的项目上使用这些扩展。
Flutter(以及整体 Flutter 开发) 由于 Docker 容器和 Codespaces 的性质,Flutter 工作流的几个方面受到限制。
  • Flutter 推荐从 snap 安装,但 snap 无法安装在 Codespaces 容器内。
  • Android 模拟在容器内不起作用。
  • Codespaces 无法检测连接到你机器的 USB 设备,这使得在物理设备上开发变得不可能。
  • Codespaces 和其他 Linux 环境一样,不支持 iOS 开发。
你可以使用本地 VS Code 进行 Flutter 开发。
LaTeX Workshop 此扩展提供三种功能来帮助 LaTeX 创作:1) 一组显示常用命令的视图,2) 一个 PDF 预览器,以及 3) 代码片段和 IntelliSense 等语言功能。该扩展可以相当全面地使用,但存在一些网页或安全限制。 以下解决方案解决了视图和预览器功能区域中的限制
  • 视图本身可以正常工作,但有些命令会尝试启动本机应用程序,例如在操作系统文件浏览器中显示输出文件夹。这些在网页版中不起作用,因此使用桌面版是一个替代方案。
  • "latex-workshop.view.pdf.viewer" - 此设置提供了一个类似于Markdown 预览的 PDF 预览器。你可以在浏览器标签页中、单独的 PDF 预览器中或 VS Code 标签页中预览。
    在基于网页的 Codespaces 中,只有浏览器标签页可用。单独的 PDF 预览器会静默失败,而 VS Code 标签页则遇到内容安全策略问题。由于此限制,VS Code 标签页预览器还具有其他不可用的功能。
Git Graph 某些 Git Graph 网页视图功能在 Codespaces 中可能受到限制。例如,在提交文件和 Git Graph 网页视图之间切换可能会导致网页视图变为空白。 你可以在 VS Code 桌面版中完全使用 Git Graph。
其他远程开发扩展(WSL、开发容器、远程 - SSH)无法安装在 Codespace 中。 Codespace 本身就是一个远程上下文。 如果你想在另一个远程上下文(例如 WSL 或远程 SSH 计算机)中运行,请打开 VS Code 桌面版(不连接到 Codespace)并启动其他远程扩展之一。如果你想使用自定义开发容器,你可以在 Codespaces 和开发容器中使用相同的 .devcontainer
我最喜欢的扩展不起作用,并且未在上面列出。 还有一些其他问题可能会阻止功能在远程上下文中按预期工作。 在某些情况下,你可以使用另一个命令来解决问题,但在其他情况下,可能需要修改扩展。请查看远程扩展提示,了解常见的远程问题和解决它们的技巧。

常见问题

为什么无法在浏览器中安装扩展

少数扩展具有内置假设或需要在桌面上运行。例如,当扩展访问桌面上的 VS Code 安装文件,或者当扩展依赖于必须在桌面环境中运行的可执行文件时。当你尝试在浏览器中安装此类扩展时,系统会通知你该扩展不可用。

请注意,当从在桌面上运行的 VS Code 连接到 Codespace 时,此类扩展仍可使用。

如何允许 VS Code 访问我的剪贴板以进行读取?

在某些情况下,VS Code 在从剪贴板读取时可能会请求你授予访问剪贴板的权限。你应该能够通过浏览器设置(搜索“站点权限”)或在地址栏右侧查找此选项来授予剪贴板访问权限

Allow clipboard access in browser

一旦你授予 VS Code 访问剪贴板的权限,你就可以重试该操作。

如何允许 VS Code 始终打开新标签页和窗口?

有时浏览器出于安全考虑会阻止 VS Code 打开新标签页或窗口。如果发生这种情况,VS Code 会检测到阻止行为并明确提示用户。但是,你可以通过在浏览器导航栏中通过上下文菜单打开站点设置并允许弹出窗口来允许 VS Code 始终打开新窗口和标签页。

Allow pop-up window in browser

如何允许浏览器中的 VS Code 访问本地文件和文件夹?

从浏览器在 VS Code 中打开本地文件和文件夹需要浏览器支持 文件系统访问 API。截至目前,Microsoft Edge 和 Google Chrome 都提供了这种级别的支持。如果你在使用浏览器中的 VS Code 时想访问本地文件和文件夹,请考虑切换到这两种浏览器之一。

问题或反馈

如果你有疑问,可以查阅 GitHub Codespaces 故障排除指南。如果你想提供反馈,可以在 GitHub Codespaces 讨论区中提出问题。