打开现有的 Codespace

你可以重新打开已关闭或停止的 Codespace，并返回到你的工作中。

本文中

备注

  • 目前，将 GitHub Codespaces 与 JetBrains IDE 结合使用处于公测阶段，可能会发生变化。
  • 要在 JetBrains IDE 中处理 codespace，你必须使用 JetBrains Gateway 的 2023.3.* 或 2024.1.* 版本。

你可以在 GitHub.com、JetBrains IDE、Visual Studio Code 中或使用 GitHub CLI 重新打开任何处于活动或已停止状态的 codespace。你无法重新打开已删除的 codespace。有关详细信息，请参阅“了解 codespace 生命周期”。

你可以在 github.com/codespaces 上的“你的 codespace”页面查看你的所有 codespace。在此页面中，你可以

从存储库页面恢复 codespace

在 GitHub.com 上查看存储库时，你可以快速恢复 codespace。

  1. 在 GitHub.com 上显示存储库的 代码选项卡中，按 ,（逗号键）。

    将显示“恢复 codespace”页面。这允许你恢复当前选定的存储库分支或（如果你正在查看拉取请求）拉取请求的主题分支中最近使用的 codespace。

    Screenshot of the "Resume codespace" page showing the "Resume this codespace" and "Create a new one" buttons.

  2. 单击恢复此 codespace。

    或者，如果你想为存储库的此分支创建新的 codespace，请单击创建新的 codespace。

    注意：如果你没有此分支的现有 codespace，则该页面标题为“创建 codespace”，并显示一个标记为创建新的 codespace的按钮。

如果你想快速返回此页面来恢复你的 Codespace，可以将此页面的地址加入书签。或者，你也可以通过链接中的地址，为其他人提供一种快速创建和恢复他们自己的 Codespace 的方法。

从“你的 Codespace”页面打开现有的 Codespace

  1. 在 GitHub.com 的左上角，选择 ，然后单击 Codespace，将你带到 github.com/codespaces 上的“你的 Codespace”页面。

  2. 要在默认编辑器中打开 Codespace，请单击 Codespace 的名称。你可以在个人设置页面中设置 Codespace 的默认编辑器。有关更多信息，请参阅“为 GitHub Codespace 设置默认编辑器”。

    要在非默认编辑器中打开 Codespace

    1. 单击要打开的 Codespace 右侧的省略号 (...)。
    2. 单击在中打开。
    3. 单击在应用程序中打开。

    Screenshot of the "Open in" dialog, with "Open in Visual Studio Code" highlighted.

    你可以在以下位置打开 Codespace

    • 你的浏览器
    • Visual Studio Code
    • JetBrains Gateway
    • JupyterLab

    如果你选择Visual Studio Code 或JetBrains Gateway，则必须确保已在本地计算机上安装所选应用程序。

    如果你选择JupyterLab，则必须在 Codespace 中安装 JupyterLab 应用程序。默认开发容器映像包括 JupyterLab，因此从默认映像创建的 Codespace 始终会安装 JupyterLab。有关默认映像的更多信息，请参阅“开发容器简介”和 devcontainers/images 存储库。如果你未在开发容器配置中使用默认映像，可以通过将 ghcr.io/devcontainers/features/python 特性添加到 devcontainer.json 文件来安装 JupyterLab。你应该包含选项 "installJupyterlab": true。有关更多信息，请参阅 devcontainers/features 存储库中 python 特性的 自述文件。

链接到现有代码空间

你可以创建到现有代码空间的链接。如果你有一个长期使用的代码空间并经常返回，这将非常有用。你可以将链接保存在你选择的位置，作为使用 https://github.com/codespaces 上的链接的替代方案。

注意：你只能打开你自己的代码空间。如果有人点击到你某个代码空间的链接，他们将看到 404 错误消息。

使用以下 URL 模式之一创建链接。在这些 URL 中，CODESPACE-NAME 表示代码空间的唯一永久名称，例如 literate-space-parakeet-w5vg5ww5p793g7g9，而不是代码空间的显示名称。你可以通过复制 https://github.com/codespaces 页面上代码空间的链接并在 URL 中提取代码空间名称来查找代码空间的名称。

链接在以下位置打开链接语法
VS Code 网页客户端https://CODESPACE-NAME.github.dev
具有指定工作区的 VS Code 网页客户端https://CODESPACE-NAME.github.dev?folder=/workspaces/PATH/TO/WORKSPACE/DIRECTORY
VS Code 桌面应用程序https://github.com/codespaces/CODESPACE-NAME?editor=vscode
JetBrains Gatewayhttps://github.com/codespaces/CODESPACE-NAME?editor=jetbrains
JupyterLabhttps://github.com/codespaces/CODESPACE-NAME?editor=jupyter

重新打开现有代码空间

注意：要在 VS Code 中使用 GitHub Codespaces，你需要安装 Codespaces 扩展。有关更多信息，请参阅“在 Visual Studio Code 中使用 GitHub Codespaces”。

  1. 在 VS Code 桌面应用程序中，使用 Command+Shift+P（Mac）或 Ctrl+Shift+P（Windows/Linux）打开命令面板。

  2. 键入“Codespaces”，然后选择以下命令之一。

    • 要在 VS Code 的新窗口中打开代码空间，请选择Codespaces：在新窗口中打开代码空间
    • 要在 Web 编辑器中打开代码空间，请选择Codespaces：在浏览器中打开

  3. 单击要打开的代码空间。

    Screenshot of the VS Code Command Palette showing a list of codespaces available to connect to.

你还可以通过导航到 VS Code 中的远程资源管理器视图并右键单击要打开的代码空间来访问上面列出的命令。

Screenshot of a codespace selected in the Remote Explorer, with "Open in Browser" highlighted in the right-click menu.

注意：如果活动栏中未显示远程资源管理器

  1. 访问命令面板。例如，通过按 Shift+Command+P（Mac）/ Ctrl+Shift+P（Windows/Linux）。
  2. 键入：details。
  3. 单击Codespaces：详细信息。

链接到现有代码空间

你可以创建到现有代码空间的链接。如果你有一个长期使用的代码空间并经常返回，这将非常有用。你可以将链接保存在你选择的位置，作为使用 https://github.com/codespaces 上的链接的替代方案。

注意：你只能打开你自己的代码空间。如果有人点击到你某个代码空间的链接，他们将看到 404 错误消息。

使用以下 URL 模式之一创建链接。在这些 URL 中，CODESPACE-NAME 表示代码空间的唯一永久名称，例如 literate-space-parakeet-w5vg5ww5p793g7g9，而不是代码空间的显示名称。你可以通过复制 https://github.com/codespaces 页面上代码空间的链接并在 URL 中提取代码空间名称来查找代码空间的名称。

链接在以下位置打开链接语法
VS Code 网页客户端https://CODESPACE-NAME.github.dev
具有指定工作区的 VS Code 网页客户端https://CODESPACE-NAME.github.dev?folder=/workspaces/PATH/TO/WORKSPACE/DIRECTORY
VS Code 桌面应用程序https://github.com/codespaces/CODESPACE-NAME?editor=vscode
JetBrains Gatewayhttps://github.com/codespaces/CODESPACE-NAME?editor=jetbrains
JupyterLabhttps://github.com/codespaces/CODESPACE-NAME?editor=jupyter

重新打开现有代码空间

如果你已安装 GitHub CLI，则可以使用它来使用 GitHub Codespaces。有关 GitHub CLI 的安装说明，请参阅 GitHub CLI 存储库。

  1. 在终端中，输入以下 GitHub CLI 命令之一。

    • 要在 VS Code 中打开代码空间，请输入

      Shell
      gh codespace code

      注意：你的本地计算机上必须安装 VS Code。有关更多信息，请参阅 VS Code 文档中的“设置 Visual Studio Code”。

    • 要在浏览器中打开代码空间，请输入

      Shell
      gh codespace code --web

    • 要在 JupyterLab 中打开代码空间，请输入

      Shell
      gh codespace jupyter

      注意：JupyterLab 应用程序必须安装在你要打开的代码空间中。默认开发容器映像包含 JupyterLab，因此从默认映像创建的代码空间将始终安装 JupyterLab。有关默认映像的更多信息，请参阅“开发容器简介”和devcontainers/images 存储库。如果你未在开发容器配置中使用默认映像，则可以通过将 ghcr.io/devcontainers/features/python 功能添加到 devcontainer.json 文件来安装 JupyterLab。你应该包含选项 "installJupyterlab": true。有关更多信息，请参阅 devcontainers/features 存储库中的python 功能的自述文件。

    • 要通过 SSH 从命令行访问代码空间，请输入

      Shell
      gh codespace ssh

  2. 使用箭头键导航到要打开的代码空间。

  3. 要打开代码空间，请按 Enter。

有关更多信息，请参阅 GitHub CLI 手册中的gh codespace code。

重新打开现有代码空间

如果你已将 JetBrains Gateway 设置为默认编辑器，则当你从 GitHub.com 打开代码空间时，Gateway 将自动启动。

如果 JetBrains Gateway 不是你的默认编辑器，你仍然可以通过访问 github.com/codespaces 上的“你的代码空间”页面，然后单击要打开的代码空间右侧的省略号 (...) 来在 JetBrains 中打开代码空间。有关更多信息，请参阅“打开现有代码空间”。

或者，你还可以按照以下步骤所述打开 JetBrains Gateway 并选择现有代码空间。

  1. 打开 JetBrains Gateway 应用程序。

  2. 单击连接到 Codespaces。

    Screenshot of the JetBrains Gateway home page, showing the "Connect to Codespaces" button.

  3. 在“你的 Codespaces”列表中，单击你想要使用的 codespace。

    Screenshot of the "Your Codespaces" list in the JetBrains Gateway.

  4. 在“可用 IDE”列表中，单击你想要使用的 JetBrains IDE。下次你连接到 codespace 时，Gateway 将记住你的选择。

    Screenshot the "Select IDE" dropdown list in the JetBrains Gateway. The mouse pointer is pointing to "IntelliJ IDEA."

  5. 单击连接。

    备注:

    • 如果你选择 Rider 作为你的 JetBrains IDE，并且存储库包含多个解决方案文件，则会显示“设置解决方案路径”对话框，提示你选择你想要使用的解决方案。从下拉菜单中选择一个解决方案文件，然后单击确定。

      如果存储库没有解决方案文件，Rider 将在基本项目目录视图中打开，并且功能有限。例如，你将无法获得特定于 .NET 的代码导航。如果存储库中只有一个解决方案文件，它将自动使用，而不会显示提示。有关更多信息，请参阅 JetBrains 文档中的“创建和打开项目和解决方案”。

    • 如果你正在运行防火墙，那么当你第一次连接到远程资源时，可能会提示你允许 JetBrains Gateway 在你的网络中进行通信。

进一步阅读