Using Codespaces in Visual Studio Code

You can develop in your codespace directly in Visual Studio Code by connecting the GitHub Codespaces extension with your account on GitHub.

Codespaces is available for user accounts using GitHub Free or GitHub Pro. For more information, see "GitHub's products."

In this article

Note: Codespaces is currently in limited public beta and subject to change. During the beta period, GitHub does not make any guarantees about the availability of Codespaces. For more information about joining the beta, see "About Codespaces."

Prerequisites

To develop in a codespace directly in Visual Studio Code, you must sign into the GitHub Codespaces extension. The GitHub Codespaces extension requires Visual Studio Code October 2020 Release 1.51 or later.

  1. Use the Visual Studio Marketplace to install the GitHub Codespaces extension. For more information, see Extension Marketplace in the Visual Studio Code documentation.
  2. In Visual Studio Code, in the left sidebar, click the Remote Explorer icon.
    The Remote Explorer icon in Visual Studio Code
  3. Use the "REMOTE EXPLORER" drop-down, then click GitHub Codespaces.
    The Codespaces header
  4. Click Sign in to view Codespaces....
    Signing in to view Codespaces
  5. To authorize Visual Studio Code to access your account on GitHub, click Allow.
  6. Sign in to GitHub to approve the extension.

Creating a codespace in Visual Studio Code

After you connect your GitHub account to the Visual Studio Codespaces extension, you can develop in a codespace that you created on GitHub or in Visual Studio Code.

  1. In Visual Studio Code, in the left sidebar, click the Remote Explorer icon.
    The Remote Explorer icon in Visual Studio Code
  2. Click the Add icon, then click Create New Codespace.
    The Create new Codespace option in Codespaces
  3. Type, then click the repository's name you want to develop in.
    Searching for repository to create a new Codespaces
  4. Click the branch you want to develop on.
    Searching for a branch to create a new Codespaces
  5. Click the instance type you want to develop in.
    Instance types for a new Codespaces

Opening a codespace in Visual Studio Code

  1. In Visual Studio Code, in the left sidebar, click the Remote Explorer icon.
    The Remote Explorer icon in Visual Studio Code
  2. Under Codespaces, click the codespace you want to develop in.
  3. Click the Connect to Codespace icon.
    The Connect to Codespace icon in Visual Studio Code

Deleting a codespace in Visual Studio Code

  1. Under Codespaces, right-click the codespace you want to delete.
  2. In the drop-down menu, click Delete Codespace.
    Deleting a codespace in GitHub

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.