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.
Use the Visual Studio Marketplace to install the GitHub Codespaces extension. For more information, see Extension Marketplace in the Visual Studio Code documentation.
- In Visual Studio Code, in the left sidebar, click the Remote Explorer icon.
- Click Sign in to view GitHub....
- To authorize Visual Studio Code to access your account on GitHub, click Allow.
- Sign in to GitHub to approve the extension.
- In Visual Studio Code, in the left sidebar, click the Remote Explorer icon.
- Use the "REMOTE EXPLORER" drop-down, then click GitHub Codespaces.
- Click Sign in to view Codespaces....
- To authorize Visual Studio Code to access your account on GitHub, click Allow.
- Sign in to GitHub to approve the extension.
Creating a codespace in Visual Studio Code
After you connect your GitHub account to the GitHub Codespaces extension, you can develop in a codespace that you created on GitHub or in Visual Studio Code.
- In Visual Studio Code, in the left sidebar, click the Remote Explorer icon.
- Click the Add icon, then click Create New Codespace.
- Type, then click the repository's name you want to develop in.
- Click the branch you want to develop on.
- Click the machine type you want to develop in.
Opening a codespace in Visual Studio Code
- In Visual Studio Code, in the left sidebar, click the Remote Explorer icon.
- Under "Codespaces", click the codespace you want to develop in.
- Click the Connect to Codespace icon.
Changing the machine type in Visual Studio Code
You can run your codespace on a choice of remote machine, from 2 cores to 32 cores. Each of these has a different level of resources and a different billing tier. For information, see "About billing for Codespaces."
You can change the machine type of your codespace at any time.
- In Visual Studio Code, open the Command Palette (
shift command P
/shift control P
). - Search for and select "Codespaces: Change Machine Type."
- Click the codespace that you want to change.
- Choose the machine type you want to use.
If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click Yes if you want to change the machine type used for this codespace immediately. If you click No, or if the codespace is not currently running, the change will take effect the next time the codespace restarts.
Deleting a codespace in Visual Studio Code
- Under "Codespaces", right-click the codespace you want to delete.
- In the drop-down menu, click Delete Codespace.