Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com>
3.3 KiB
title, intro, product, versions, type, topics, shortTitle
| title | intro | product | versions | type | topics | shortTitle | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Renaming a codespace | You can use the {% data variables.product.prodname_cli %} to change the codespace display name to one of your choice. | {% data reusables.gated-features.codespaces %} |
|
how_to |
|
Rename a codespace |
About renaming a codespace
Each codespace is 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.
-
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 shown below the repository name. For example:
symmetrical space telegramin the screenshot below.
{% 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, the repository name, and some random characters. For example: octocat-myrepo-gmc7. You can't change this 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 Open in browser option on https://github.com/codespaces.
-
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. You can change the display name for your codespace by using the {% data variables.product.prodname_cli %}.
To rename 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 "Using {% data variables.product.prodname_github_codespaces %} with {% data variables.product.prodname_cli %}."


