jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'universe-2022-megabranch' into codespaces-universe-megabranch

Browse Source
This commit is contained in:
Jules
2022-11-08 10:12:42 +01:00
committed by GitHub
parent ef5ce33c86 96b3b4b74c
commit cf49b4e28d
167 changed files with 1704 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
content/codespaces/customizing-your-codespace/renaming-a-codespace.md
View File

@@ -1,6 +1,7 @@
---
title: Renaming a codespace
intro: 'You can use the {% data variables.product.prodname_cli %} to change the codespace display name to one of your choice.'
intro: '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 %}.'
product: '{% data reusables.gated-features.codespaces %}'
versions:
fpt: '*'
ghec: '*'
@@ -31,11 +32,11 @@ To find the display name of a codespace:
### 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.
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 **Open in browser** option on https://github.com/codespaces.
* 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 codespace name shown on hover over](/assets/images/help/codespaces/find-codespace-name-github.png)
@@ -44,7 +45,11 @@ To find the permanent name of a codespace:
## 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 %}.
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 %}
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:
@@ -55,3 +60,20 @@ 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 %}](/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli#rename-a-codespace)."
{% 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**.
1. In the prompt, under "Change display name to..." type your desired display name and click **OK**.
{% endwebui %}