2.6 KiB
title, intro, product, versions, type, topics, shortTitle
| title | intro | product | versions | type | topics | shortTitle | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Renaming a codespace | You can use the GitHub 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:
- View your list of codespaces in {% data variables.product.product_name %} on https://github.com/codespaces.
- Click the Remote Explorer in the {% data variables.product.prodname_vscode %} desktop application, or the {% data variables.product.prodname_vscode_shortname %} web client. For example:
symmetrical space telegramin the screenshot below.
When you create a codespace, a unique 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 unique name of a codespace:
- Use this {% data variables.product.prodname_cli %} command in a terminal on your local machine:
gh codespace list. - Use this command in the terminal of your codespace:
echo $CODESPACE_NAME. - Access the name in {% data variables.product.product_name %} on https://github.com/codespaces. The name is shown in a pop-up when you hover over the Open in browser option on https://github.com/codespaces.
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 <em>unique name of the codespace</em> -d <em>new display name</em>
In this example, replace unique name of the codespace with the unique name of the codespace. Replace new display name with the desired display name.