跳至主要内容

打开现有 Codespace

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

备注

  • 目前,使用 JetBrains IDE 的 GitHub Codespaces 处于公开测试阶段,可能会发生变化。
  • 要在 JetBrains IDE 中使用 Codespace,您必须使用 JetBrains Gateway 的 2023.3.* 或 2024.1.* 版本。

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

您可以在“您的 Codespace”页面(位于 github.com/codespaces)上查看所有 Codespace。

  • 您可以打开、停止或删除您的 Codespace。
  • 查看谁拥有(以及可能为其付费)您的 Codespace:您的个人帐户或您所属的组织。有关更多信息,请参阅“关于 GitHub Codespace 的计费”。
  • 查看您的 Codespace 的机器类型、大小和状态。
  • 创建一个新的 Codespace,方法是选择 GitHub 的模板之一,或单击“新建 Codespace”。有关更多信息,请参阅“从模板创建 Codespace”和“为仓库创建 Codespace”。
  • 防止自动删除 Codespace。有关更多信息,请参阅“配置 Codespace 的自动删除”。

从仓库页面恢复 Codespace

您可以在 GitHub.com 上查看仓库时快速恢复 Codespace。

  1. 在 GitHub.com 上显示的仓库的 代码选项卡中,按 ,(逗号键)。

    将显示“恢复 Codespace”页面。这使您可以恢复最近用于仓库当前所选分支的 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

  1. 在 GitHub.com 的左上角,选择 ,然后点击 Codespaces,这将带您前往 github.com/codespaces 上的“您的 Codespaces”页面。

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

    要在除默认编辑器以外的编辑器中打开 Codespace

    1. 点击您要打开的 Codespace 右侧的省略号 (...)。
    2. 点击 在...中打开
    3. 点击 在 APPLICATION 中打开

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

    您可以在以下位置打开 Codespace:

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

    如果您选择 Visual Studio CodeJetBrains Gateway,则必须确保已在本地机器上安装所选应用程序。

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

链接到现有 Codespace

您可以创建指向现有 Codespaces 的链接。如果您有一个经常返回的长期运行的 Codespace,这将非常有用。您可以将链接保存在您选择的位置,作为使用 https://github.com/codespaces 上的链接的替代方法。

注意:您只能打开自己的 Codespaces。如果有人点击指向您其中一个 Codespace 的链接,他们将看到 404 错误消息。

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

链接将在链接语法
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:在新窗口中打开代码空间
    • 要在网页编辑器中打开代码空间,请选择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:详细信息

链接到现有 Codespace

您可以创建指向现有 Codespaces 的链接。如果您有一个经常返回的长期运行的 Codespace,这将非常有用。您可以将链接保存在您选择的位置,作为使用 https://github.com/codespaces 上的链接的替代方法。

注意:您只能打开自己的 Codespaces。如果有人点击指向您其中一个 Codespace 的链接,他们将看到 404 错误消息。

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

链接将在链接语法
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。有关更多信息,请参阅 python 功能的 README,位于 devcontainers/features 存储库中。

    • 要从命令行通过 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. 单击连接到代码空间

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

  3. 在“您的代码空间”列表中,单击您要使用的代码空间。

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

  4. 在“可用 IDE”列表中,单击您要使用的 JetBrains IDE。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 在您的网络中进行通信。

进一步阅读