Using Codespaces in Visual Studio Code

About Codespaces in Visual Studio Code

You can use your local install of Visual Studio Code to create, manage, work in, and delete codespaces. To use Codespaces in Visual Studio Code, you need to install the GitHub Codespaces extension. For more information on setting up Codespaces in Visual Studio Code, see "Prerequisites."

By default, if you create a new codespace on GitHub.com, it will open in the browser. If you would prefer to open any new codespaces in Visual Studio Code automatically, you can set your default editor to be Visual Studio Code. For more information, see "Setting your default editor for Codespaces."

If you prefer to work in the browser, but want to continue using your existing Visual Studio Code extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "Personalizing Codespaces for your account."

Prerequisites

To develop in a codespace directly in Visual Studio Code, you must install and sign into the GitHub Codespaces extension with your GitHub credentials. 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.

Creating a codespace in Visual Studio Code

After you connect your account on GitHub.com to the GitHub Codespaces extension, you can create a new codespace. For more information about the GitHub Codespaces extension, see the Visual Studio Code marketplace.

1. 在 Visual Studio Code 中，从左侧边栏单击 Remote Explorer 图标。

2. Click the Add icon: .

   

3. Type the name of the repository you want to develop in, then select it.

   

4. 单击要在其中开发的分支。

   

5. Click the machine type you want to use.

   

   注：Your choice of available machine types may be limited by a policy configured for your organization, or by a minimum machine type specification for your repository. For more information, see "Restricting access to machine types" and "Setting a minimum specification for codespace machines."

Opening a codespace in Visual Studio Code

1. 在 Visual Studio Code 中，从左侧边栏单击 Remote Explorer 图标。

2. Under "Codespaces", click the codespace you want to develop in.

3. Click the Connect to Codespace icon.

   

Changing the machine type in Visual Studio Code

Typically, you can run your codespace on a choice of remote machine, from 2 cores to 32 cores. 每种类型都有不同的资源水平和不同的计费等级。 相关信息请参阅“关于代码空间的计费”。

By default the machine type with the lowest valid resources is used when you create a codespace. You can change the machine type of your codespace at any time.

1. In Visual Studio Code, open the Command Palette (shift command P / shift control P).

2. Search for and select "Codespaces: Change Machine Type."

   

3. Click the codespace that you want to change.

   

4. Choose the machine type you want to use.

   Note: Your choice of available machine types may be limited by a policy configured for your organization, or by a minimum machine type specification for your repository. For more information, see "Restricting access to machine types" and "Setting a minimum specification for codespace machines."

5. 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

You can delete codespaces from within Visual Studio Code when you are not currently working in a codespace.

1. 在 Visual Studio Code 中，从左侧边栏单击 Remote Explorer 图标。

2. Under "GITHUB CODESPACES", right-click the codespace you want to delete.

3. Click Delete Codespace.

   

Switching to the Insiders build of Visual Studio Code

You can use the Insiders Build of Visual Studio Code within Codespaces.

1. In bottom left of your Codespaces window, select Settings.

2. From the list, select "Switch to Insiders Version".

   

3. Once selected, Codespaces will continue to open in Insiders Version.