Skip to main content

重命名 codespace

可以将 codespace 显示名称更改为在 GitHub 选择的名称之一,或者使用 GitHub CLI 更改 codespace 显示名称。

Tool navigation

关于重命名 codespace

创建 codespace 时,会为其分配自动生成的显示名称。 如果有多个 codespace,则显示名称有助于区分不同 codespace。 例如:literate space parakeet。 可以更改 codespace 的显示名称。

若要查找 codespace 的显示名称,请执行以下操作:

  • 在 GitHub 上,在 https://github.com/codespaces 处查看 codespace 列表。

    https://github.com/codespaces 页面上的三个 codespace 列表的屏幕截图。

  • 在 Visual Studio Code 桌面应用程序中,或在 VS Code Web 客户端中,单击远程资源管理器。 显示名称是列表中的第二项。 例如:以下屏幕截图中的 psychic chainsaw

    VS Code 中“远程资源管理器”的屏幕截图。 codespace 显示名称“psychic chainsaw”以深橙色边框突出显示。

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

    1. 访问命令面板。 例如,通过按 Shift+Command+P (Mac)/Ctrl+Shift+P (Windows/Linux)。
    2. 键入:details
    3. 单击“Codespace: 详细信息”。
  • 在本地计算机上的终端窗口中,使用这条 GitHub CLI 命令:gh codespace list

永久 codespace 名称

除了显示名称,每个 CodeSpace 还具有唯一的永久名称。 永久名称是初始显示名称后跟一些随机字符的组合,例如 literate-space-parakeet-w5vg5ww5p793g7g9。 无法更改永久名称。

有时需要知道 CodeSpace 的永久名称。 例如,使用某些 GitHub CLI 命令时,或者讨论具有 GitHub 支持的特定 CodeSpace 时。

要查找 Codespace的永久名称,请执行以下操作:

  • 在浏览器中打开代码空间。 URL 的子域是代码空间的名称。 例如:https://obscure-space-engine-grx7rgg6qp43v9j5.github.devobscure-space-engine-grx7rgg6qp43v9j5 codespace 的 URL。
  • 如果无法打开 Codespace,可从 https://github.com/codespaces 上的 Codespace 列表中访问该名称。 右键单击 Codespace 的显示名称,然后选择浏览器用于复制链接地址的选项。 复制的 URL 的最后一部分是 Codespace 的永久名称。
  • 在 codespace 中,在终端中使用此命令:echo $CODESPACE_NAME
  • 如果在本地或 Codespace 中安装了 GitHub CLI,请在终端中使用以下命令列出所有 Codespace:gh codespace list

Codespace 的永久名称也包含在许多日志文件中。 例如,在 GitHub Codespaces 扩展日志中,位于 fetching codespaceConnecting to codespace 之后;在浏览器控制台日志中,位于 clientUrl 之后。 有关详细信息,请参阅“GitHub Codespaces 日志”。

重命名 codespace

如果有多个要在较长时间内使用的 codespace,更改 codespace 的显示名称可能很有用。 适当的名称有助于识别用于特定用途的 codespace。

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

要更改 codespace 的显示名称,请使用 gh codespace edit 子命令:

gh codespace edit -c PERMANENT-CODESPACE-NAME -d 'NEW-DISPLAY-NAME'

在本例中,用想要更改其显示名称的 codespace 的永久名称替换 PERMANENT-CODESPACE-NAME。 用想用于此 codespace 的显示名称替换 NEW-DISPLAY-NAME

显示名称最长可为 48 个字符。 显示名称可以包含字符(包括空格)的任意组合,前提是你要将其括在单引号中。

有关详细信息,请参阅“将 GitHub Codespaces 与 GitHub CLI 配合使用”。

可以使用 GitHub 更改 codespace 的显示名称。

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

    The current display name for each of your codespaces is displayed.

  2. 单击要修改的 codespace 右侧的省略号 (...)。

  3. 单击“重命名”。

  4. 在提示符中,在“将显示名称更改为...”下键入所需的显示名称,然后单击“ 确定”。

延伸阅读