重命名 codespace

您可以通过 GitHub.com 或 GitHub CLI 将 codespace 显示名称更改为您选择的名称。

本文档

关于重命名 codespace

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

查找 codespace 的显示名称

  • 在 GitHub 上，在 https://github.com/codespaces 查看您的 codespace 列表。

    Screenshot of a list of three codespaces on the https://github.com/codespaces page."

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

    Screenshot of the "Remote Explorer" in VS Code. The codespace display name, "psychic chainsaw," is highlighted with a dark orange outline.

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

    1. 访问命令面板。例如，按 Shift+Command+P（Mac）/ Ctrl+Shift+P（Windows/Linux）。
    2. 输入：details。
    3. 点击Codespaces: Details。

  • 在本地机器的终端窗口中，使用以下 GitHub CLI 命令：gh codespace list。

永久性 Codespace 名称

除了显示名称之外，每个 Codespace 还有一个唯一的永久名称。永久名称是初始显示名称加上一些随机字符的组合，例如 literate-space-parakeet-w5vg5ww5p793g7g9。您无法更改永久名称。

您有时需要知道 Codespace 的永久名称。例如，当您使用某些 GitHub CLI 命令或与 GitHub 支持人员讨论特定 Codespace 时。

要查找 Codespace 的永久名称，请执行以下操作之一

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

Codespace 的永久名称也包含在许多日志文件中。例如，在 GitHub Codespaces 扩展日志中，在 fetching codespace 或 Connecting 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'

在本例中，请将 PERMANENT-CODESPACE-NAME 替换为要更改显示名称的 codespace 的永久名称。将 NEW-DISPLAY-NAME 替换为要用于此 codespace 的显示名称。

显示名称的长度最多可达 48 个字符。显示名称可以包含任何字符组合，包括空格，前提是您将其用单引号括起来。

有关更多信息，请参阅“使用 GitHub Codespaces 与 GitHub CLI”。

您可以在 GitHub.com 上更改 codespace 的显示名称。

  1. 在 GitHub.com 的左上角，选择 ，然后单击 Codespaces，这将带您进入 github.com/codespaces 上的“您的 codespaces”页面。

    将显示每个 codespace 的当前显示名称。

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

  3. 单击重命名。

  4. 在提示中，在“将显示名称更改为...”下，键入您想要的显示名称，然后单击确定。

进一步阅读