SOLFIND
Web Lens
Portal home

Renaming a codespace - GitHub Docs

https://docs.github.com/en/codespaces/customizing-your-codespace/renaming-a-codespace • 177 KB fetched
Open original page


Renaming a codespace - GitHub Docs Skip to main content GitHub Docs Version: Free, Pro, & Team Search or ask Copilot Search or ask Copilot Select language: current language is English Search or ask Copilot Search or ask Copilot Open menu Collapse sidebar Expand sidebar Scroll breadcrumbs left * Home * Codespaces * Customizing your codespace * Rename a codespace Scroll breadcrumbs right Codespaces * * * Quickstart * Getting started * What are Codespaces? * Codespaces features * The codespace lifecycle * Deep dive into Codespaces * Developing in a codespace * Develop in a codespace * Create a codespace for a repo * Create a codespace from a template * Delete a codespace * Open an existing codespace * Work collaboratively * Source control * Pull requests * Stop a codespace * Forward ports * Rebuilding a container * Default environment variables * Persist variables and files * Connecting to a private network * Machine learning * Visual Studio Code * GitHub CLI * Customizing your codespace * Rename a codespace * Change your shell * Change the machine type * Setting your user preferences * Personalize your codespaces * Set the default editor * Set the default region * Set the timeout * Configure automatic deletion * Choose the host image * Setting up your project * Adding a dev container configuration * Introduction to dev containers * Setting up a Node.js project * Setting up a C# (.NET) project * Setting up a Java project * Setting up a PHP project * Setting up a Python project * Configuring dev containers * Set a minimum machine spec * Adding features * Automatically opening files * Specifying recommended secrets * Setting up your repository * Facilitating codespace creation * Set up a template repo * Prebuilding your codespaces * About prebuilds * Configure prebuilds * Allow external repo access * Manage prebuilds * Test dev container changes * Managing your codespaces * Codespaces secrets * Repository access * Security logs * GPG verification * Managing your organization * Enable or disable Codespaces * Billing and ownership * List organization codespaces * Manage Codespaces costs * Manage secrets * Audit logs * Restrict machine types * Restrict codespace creation * Restrict base image * Restrict port visibility * Restrict timeout periods * Restrict the retention period * Reference * Access a private registry * Copilot in Codespaces * VS Code Command Palette * Security in Codespaces * Disaster recovery * Troubleshooting * Codespaces logs * Codespaces clients * Included usage * Exporting changes * Creation and deletion * Authenticating to repositories * Connection * Codespaces prebuilds * Personalization * Port forwarding * GPG verification * Working with support * github.dev editor Renaming a codespace You can change the codespace display name to one of your choice on GitHub or using the GitHub CLI. Tool navigation * GitHub CLI * Web browser Copy as Markdown In this article * About renaming a codespace * Renaming a codespace * Further reading 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 GitHub, view your list of codespaces at https://github.com/codespaces . * In the Visual Studio Code desktop application, or the VS Code web client, click the Remote Explorer. The display name is the second item in the list. For example: psychic chainsaw in the screenshot below. Note If the Remote Explorer is not displayed in the Activity Bar: * Access the Command Palette. For example, by pressing Shift + Command + P (Mac) / Ctrl + Shift + P (Windows/Linux). * Type: details . * Click Codespaces: Details . * In a terminal window on your local machine, use this GitHub CLI command: gh codespace list . Permanent codespace names In addition to a display name, every codespace also has a unique, permanent name. The permanent name is a combination of the initial display name, followed by some random characters - for example, literate-space-parakeet-w5vg5ww5p793g7g9 . You can't change the permanent name. You will occasionally need to know the permanent name of a codespace. For example, when you use some GitHub CLI commands, or when you discuss a particular codespace with GitHub support. To find the permanent name of a codespace, do one of the following: * Open the codespace in the browser. The subdomain of the URL is the name of the codespace. For example: https://obscure-space-engine-grx7rgg6qp43v9j5.github.dev is the URL for the obscure-space-engine-grx7rgg6qp43v9j5 codespace. * If you cannot open a codespace, you can access the name from your list of codespaces at https://github.com/codespaces . Right-click the display name of the codespace and select your browser's option for copying the link address. The final part of the URL you copy is the permanent name of the codespace. * In a codespace, use this command in the terminal: echo $CODESPACE_NAME . * If GitHub CLI is installed, either locally or in a codespace, use this command in the terminal to list all of your codespaces: gh codespace list . The permanent name the codespace is also included in many of the log files. For example, in the GitHub Codespaces extension log, after fetching codespace or Connecting to codespace , and in the browser console log after clientUrl . For more information, see GitHub Codespaces logs . 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. If you have installed GitHub CLI, you can use it to work with GitHub Codespaces. For installation instructions for GitHub CLI, see the GitHub CLI repository . 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. Display names can be up to 48 characters in length. The display name can contain any combination of characters, including spaces, provided you enclose it in single quotes. For more information, see Using GitHub Codespaces with GitHub CLI . You can change the display name for your codespace on GitHub. * In the top-left corner of GitHub, select , then click Codespaces to take you to the "Your codespaces" page at github.com/codespaces . The current display name for each of your codespaces is displayed. * Click the ellipsis ( ... ) to the right of the codespace you want to modify. * Click Rename . * In the prompt, under "Change display name to..." type your desired display name and click OK . Further reading * Setting your user preferences * Managing your codespaces Back to top Help and support Was this Doc helpful? Yes No Help us make GitHub Docs great! All Docs are open source. See something that's wrong or unclear? Submit a pull request. Make a contribution Still need help? Provide GitHub Feedback Contact support Expert services Blog GitHub Inc. © 2026 Terms Privacy Status Pricing

Links found on this page

  1. Skip to main content [direct]
  2. GitHub Docs [direct]
  3. Codespaces [direct]
  4. Customizing your codespace [direct]
  5. Quickstart [direct]
  6. What are Codespaces? [direct]
  7. Codespaces features [direct]
  8. The codespace lifecycle [direct]
  9. Deep dive into Codespaces [direct]
  10. Develop in a codespace [direct]
  11. Create a codespace for a repo [direct]
  12. Create a codespace from a template [direct]
  13. Delete a codespace [direct]
  14. Open an existing codespace [direct]
  15. Work collaboratively [direct]
  16. Source control [direct]
  17. Pull requests [direct]
  18. Stop a codespace [direct]
  19. Forward ports [direct]
  20. Rebuilding a container [direct]
  21. Default environment variables [direct]
  22. Persist variables and files [direct]
  23. Connecting to a private network [direct]
  24. Machine learning [direct]
  25. Visual Studio Code [direct]
  26. GitHub CLI [direct]
  27. Change your shell [direct]
  28. Change the machine type [direct]
  29. Personalize your codespaces [direct]
  30. Set the default editor [direct]
  31. Set the default region [direct]
  32. Set the timeout [direct]
  33. Configure automatic deletion [direct]
  34. Choose the host image [direct]
  35. Introduction to dev containers [direct]
  36. Setting up a Node.js project [direct]
  37. Setting up a C# (.NET) project [direct]
  38. Setting up a Java project [direct]
  39. Setting up a PHP project [direct]
  40. Setting up a Python project [direct]
  41. Set a minimum machine spec [direct]
  42. Adding features [direct]
  43. Automatically opening files [direct]
  44. Specifying recommended secrets [direct]
  45. Facilitating codespace creation [direct]
  46. Set up a template repo [direct]
  47. About prebuilds [direct]
  48. Configure prebuilds [direct]
  49. Allow external repo access [direct]
  50. Manage prebuilds [direct]
  51. Test dev container changes [direct]
  52. Codespaces secrets [direct]
  53. Repository access [direct]
  54. Security logs [direct]
  55. GPG verification [direct]
  56. Enable or disable Codespaces [direct]
  57. Billing and ownership [direct]
  58. List organization codespaces [direct]
  59. Manage Codespaces costs [direct]
  60. Manage secrets [direct]
  61. Audit logs [direct]
  62. Restrict machine types [direct]
  63. Restrict codespace creation [direct]
  64. Restrict base image [direct]
  65. Restrict port visibility [direct]
  66. Restrict timeout periods [direct]
  67. Restrict the retention period [direct]
  68. Access a private registry [direct]
  69. Copilot in Codespaces [direct]
  70. VS Code Command Palette [direct]
  71. Security in Codespaces [direct]
  72. Disaster recovery [direct]
  73. Codespaces logs [direct]
  74. Codespaces clients [direct]
  75. Included usage [direct]
  76. Exporting changes [direct]
  77. Creation and deletion [direct]
  78. Authenticating to repositories [direct]
  79. Connection [direct]
  80. Codespaces prebuilds [direct]