Skip to main content

Developing in a codespace

You can open a codespace on GitHub Enterprise Cloud, then develop using Visual Studio Code's features.

GitHub Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. GitHub Codespaces is also available as a limited beta release for individual users on GitHub Free and GitHub Pro plans. For more information, see "GitHub's products."

About development with GitHub Codespaces

GitHub Codespaces provides you with the full development experience of Visual Studio Code. You can edit code, debug, and use Git commands while developing in a codespace with VS Code. For more information, see the VS Code documentation.

To get started with GitHub Codespaces, see "Quickstart for GitHub Codespaces." For more information on creating or reopening a codespace, see "Creating a codespace" and "Opening an existing codespace." To learn more about how GitHub Codespaces works, see "Deep dive into GitHub Codespaces."

Codespace overview with annotations

  1. Side Bar - By default, this area shows your project files in the Explorer.
  2. Activity Bar - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them.
  3. Editor - This is where you edit your files. You can use the tab for each editor to position it exactly where you need it.
  4. Panels - This is where you can see output and debug information, as well as the default place for the integrated Terminal.
  5. Status Bar - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more.

For more information on using VS Code, see the User Interface guide in the VS Code documentation.

You can connect to your codespace directly from VS Code. For more information, see "Using Codespaces in VS Code."

For the best experience with GitHub Codespaces, we recommend using a Chromium-based browser, like Google Chrome or Microsoft Edge. For more information, see "Troubleshooting GitHub Codespaces clients."

Personalizing your codespace

You can also use a dotfiles repository and Settings Sync to personalize aspects of the codespace environment for any codespace that you create. Personalization can include shell preferences and additional tools. For more information, see "Personalizing GitHub Codespaces for your account."

After the GitHub Codespaces configuration for a repository changes, you can apply the changes to an existing codespace by rebuilding the container for the codespace. For more information, see "Introduction to dev containers."

Running your app from a codespace

You can forward ports in your codespace to test and debug your application. You can also manage the port protocol and share the port within your organization or publicly. For more information, see "Forwarding ports in your codespace."

Committing your changes

Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit your changes. Committing changes to your repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, such as adding VS Code extensions, will appear for all users.

For information, see "Using source control in your codespace."

Using the Visual Studio Code Command Palette

The Visual Studio Code Command Palette allows you to access and manage many features for GitHub Codespaces and VS Code. For more information, see "Using the VS Code Command Palette in GitHub Codespaces."