Skip to main content
All products
GitHub Codespaces

Developing in a codespace

In this article

You can work in a codespace using your browser, Visual Studio Code, a JetBrains IDE, or in a command shell.

Note: Using GitHub Codespaces with JetBrains IDEs is currently in public beta and is subject to change.

About development with GitHub Codespaces

You can develop code in a codespace using your choice of tool:

  • A command shell, via an SSH connection initiated using GitHub CLI.
  • One of the JetBrains IDEs, via the JetBrains Gateway.
  • The Visual Studio Code desktop application.
  • A browser-based version of Visual Studio Code.

The tabs in this article allow you to switch between information for each of these ways of working. You're currently on the tab for the web browser version of Visual Studio Code.

Working in a codespace in the browser

Using Codespaces in the browser provides you with a fully featured development experience. You can edit code, debug, use Git commands, and run your application.

Annotated screenshot of the five main components of the user interface: side bar, activity bar, editor, panels, status bar.

The main components of the user interface are:

  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 right-click the tab for a file to access options such as locating the file in the Explorer.
  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 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."

Customizing the codespaces for a repository

You can customize the codespaces that are created for a repository by creating or updating the dev container configuration for the repository. You can do this from within a codespace. After you change a dev container configuration, you can apply the changes to the current codespace by rebuilding the Docker container for the codespace. For more information, see "Introduction to dev containers."

Personalizing your codespace

You can 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."

Running