参加你附近的 ,了解 VS Code 中的 AI 辅助开发。

GitHub Codespaces

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

GitHub Codespaces extension

环境

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

自定义

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

自定义示例包括

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

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

每个用户的点文件配置

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

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

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

入门

GitHub Codespaces 的两个客户端都有入门主题。这些将让你快速登录 GitHub Codespaces,创建你的第一个 codespace,并使用你喜欢的客户端连接到它。

扩展作者

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

基于浏览器的编辑器

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

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

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

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

已知限制和适应性

在使用 Codespaces,特别是 Web 中的 VS Code 时,需要牢记某些限制。其中一些限制有权宜之计或适应性措施,以提供一致的开发体验。

对于一些问题(特别是键盘快捷键或桌面版有权宜之计的问题),你可以安装并使用 Codespace 作为 渐进式 Web 应用程序 (PWA)。

Installing Codespaces as PWA in Microsoft Edge

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

某些扩展在 Web 中的行为不同

扩展 问题/原因 权宜之计
键盘快捷键与浏览器快捷键重叠的扩展,例如 Git Graph,它使用 Ctrl+R 进行刷新。 键盘快捷键可能与现有的浏览器快捷键重叠,例如 Ctrl+R 在 Safari 中刷新窗口。 你可以使用基于桌面而非基于 Web 的 Codespace 来充分利用你的键盘快捷键。不同的浏览器行为也可能不同(你可以在 Chrome 中刷新 Git Graph)。
语言包,例如 Visual Studio Code 日语语言包 基于 Web 的 Codespaces 目前不支持语言包扩展。 你可以使用基于桌面的 Codespace 来使用语言包并配置显示语言。
括号对彩色器 2 它在浏览器中不起作用,因为它引入了一个不容易修复的安装位置依赖项。 使用 括号对彩色器
浏览器调试器,例如 Firefox 调试器 需要 UI/桌面扩展主机的扩展无法在浏览器中加载。 你可以在本地 VS Code 中使用这些扩展(未连接到 Codespaces)。或者,当你的应用程序在 Codespace 中运行时,你可以使用替代方案,例如 Chrome DevTools 来检查元素和设置断点。
打开浏览器的扩展,例如 在浏览器中打开 需要 UI/桌面扩展主机的扩展无法在浏览器中加载。 如果可能,请使用替代扩展,例如 Live Server
项目管理器 项目管理器依赖于同步自定义的 projects.json 文件,这 目前不支持 你可以在桌面 Codespaces 或本地 VS Code 中使用该扩展来保存和管理你的项目,因为这些选项不需要同步自定义文件。
依赖 Chrome 的扩展,例如 Protractor Test Runner浏览器预览 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) 像代码片段和智能感知这样的语言功能。该扩展可以功能齐全地使用,但存在一些 Web 或安全限制。 以下权宜之计解决了视图和预览器功能区域中的限制
  • 视图本身没有问题,但一些命令尝试启动本机应用程序,例如在操作系统文件资源管理器中显示输出文件夹。这些在 Web 中不起作用,因此使用桌面版是一个替代方案。
  • "latex-workshop.view.pdf.viewer" - 此设置提供了一个类似于 Markdown 预览 的 PDF 预览器。你可以在浏览器选项卡、单独的 PDF 预览器或 VS Code 选项卡中预览。
    只有浏览器选项卡可以在基于 Web 的 Codespaces 中使用。单独的 PDF 预览器会静默失败,并且 VS Code 选项卡会遇到 内容安全策略 问题。由于此限制,VS Code 选项卡预览器具有其他不可用的功能。
Git Graph Codespaces 中某些 Git Graph Webview 功能可能会受到限制。例如,在提交中的文件和 Git Graph Webview 之间切换可能会使 Webview 为空。 你可以在 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 讨论区 中提出问题。

© . This site is unofficial and not affiliated with Microsoft.