Skip to content

Latest commit

 

History

History
83 lines (51 loc) · 4.03 KB

renaming-a-codespace.md

File metadata and controls

83 lines (51 loc) · 4.03 KB
Raw
title intro versions type topics shortTitle
Renaming a codespace
You can change the codespace display name to one of your choice through {% data variables.product.prodname_dotcom_the_website %} or the {% data variables.product.prodname_cli %}.
fpt ghec
*
*
how_to
Codespaces
Fundamentals
Developer
Rename a codespace

About renaming a codespace

When you create a codespace it's assigned an auto-generated display name. If you have multiple codespaces, the display name helps you to differentiate between codespaces. For example: literate space parakeet. You can change the display name for your codespace.

To find the display name of a codespace:

  • On {% data variables.product.product_name %}, view your list of codespaces at https://github.com/codespaces.

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

  • In the {% data variables.product.prodname_vscode %} desktop application, or the {% data variables.product.prodname_vscode_shortname %} web client, click the Remote Explorer. The display name is the second item in the list. For example: psychic chainsaw in the screenshot below.

    Screenshot of the "Remote Explorer" in {% data variables.product.prodname_vscode_shortname %}. The codespace display name, "psychic chainsaw," is highlighted with a dark orange outline.

{% indented_data_reference reusables.codespaces.remote-explorer spaces=2 %}

  • In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: gh codespace list.

Permanent codespace names

In addition to the display name, when you create a codespace, a permanent name is also assigned to the codespace. The name is a combination of your {% data variables.product.company_short %} handle, and the auto-generated display name. For example: octocat-literate-space-parakeet-mld5. You can't change the permanent name.

To find the permanent name of a codespace:

  • On {% data variables.product.product_name %}, the permanent name is shown in a pop-up when you hover over the display name of a codespace on https://github.com/codespaces.

    Screenshot of the mouse pointer positioned over a display name, with the corresponding codespace name shown at the bottom of the browser page.

  • In a codespace, use this command in the terminal: echo $CODESPACE_NAME.

  • In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: gh codespace list.

Renaming a codespace

Changing the display name of a codespace can be useful if you have multiple codespaces that you will be using for an extended period. An appropriate name helps you identify a codespace that you use for a particular purpose.

{% cli %}

{% data reusables.codespaces.using-github-cli %}

To change the display name of a codespace, use the gh codespace edit subcommand:

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

In this example, replace PERMANENT-CODESPACE-NAME with the permanent name of the codespace whose display name you want to change. Replace NEW-DISPLAY-NAME with the display name you want to use for this codespace.

For more information, see "AUTOTITLE."

{% endcli %}

{% webui %}

You can change the display name for your codespace on {% data variables.product.prodname_dotcom_the_website %}.

{% data reusables.codespaces.your-codespaces-procedure-step %}

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

{% data reusables.codespaces.ellipsis-settings %}

  1. Click Rename.

  2. In the prompt, under "Change display name to..." type your desired display name and click OK.

{% endwebui %}

Further reading