Using GitHub Codespaces in Visual Studio Code

About GitHub 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 GitHub Codespaces in VS Code, you need to install the Codespaces extension. For more information on setting up Codespaces in VS 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 VS Code automatically, you can set your default editor to be VS Code. For more information, see "Setting your default editor for GitHub Codespaces."

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

Prerequisites

To develop in a codespace directly in VS Code, you must install and sign into the Codespaces extension with your GitHub credentials. The Codespaces extension requires VS Code October 2020 Release 1.51 or later.

Use the Visual Studio Code Marketplace to install the Codespaces extension. For more information, see Extension Marketplace in the VS Code documentation.

Creating a codespace in VS Code

将 GitHub.com 上的帐户连接到 GitHub Codespaces 扩展后，可以创建新的 codespace。 有关 GitHub Codespaces 扩展的详细信息，请参阅 VS Code Marketplace 市场。

1. In VS Code, in the left sidebar, click the Remote Explorer icon.

   

   Note: If the Remote Explorer is not displayed in the Activity Bar:

   1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
   2. Type: codespaces.
   3. Click Codespaces: Details.

2. 单击“添加”图标：。

   

3. 键入要在其中开发的存储库的名称，然后将其选中。

   

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

   

5. 如果系统提示选择开发容器配置文件，请从列表中选择一个文件。

   

6. 选择你要使用的机器类型。

   

   注意：可供选择的计算机类型可能会受为组织配置的策略或存储库的计算机类型最低规范的限制。 有关详细信息，请参阅“限制对计算机类型的访问”和“为代码空间计算机设置最低规范”。

Opening a codespace in VS Code

1. In VS Code, in the left sidebar, click the Remote Explorer icon.

   

   Note: If the Remote Explorer is not displayed in the Activity Bar:

   1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
   2. Type: codespaces.
   3. Click Codespaces: Details.

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

3. Click the Connect to Codespace icon.

   

Changing the machine type in VS Code

通常，你可以在选择的远程机器上运行 codespace，从 2 核到 32 核。 每种类型都有不同的资源水平和不同的计费等级。 有关信息，请参阅“关于 GitHub Codespaces 的计费”。

默认情况下，创建 codespace 时将使用具有最低有效资源的计算机类型。 You can change the machine type of your codespace at any time.

1. In VS 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: 可供选择的计算机类型可能会受为组织配置的策略或存储库的计算机类型最低规范的限制。 有关详细信息，请参阅“限制对计算机类型的访问”和“为代码空间计算机设置最低规范”。

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 VS Code

如你当前未在 codespace 中工作，可从 VS Code 内删除 codespace。

1. In VS Code, in the left sidebar, click the Remote Explorer icon.

   

   Note: If the Remote Explorer is not displayed in the Activity Bar:

   1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
   2. Type: codespaces.
   3. Click Codespaces: Details.

2. 在“GitHub Codespaces”下，右键点击你要删除的 codespace。

3. 单击“删除 codespace”。

   

Switching to the Insiders build of VS Code

You can use the Insiders Build of VS 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.