Skip to main content

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.

代码空间可用于使用 GitHub Team 或 GitHub Enterprise Cloud 的组织。 更多信息请参阅“GitHub 的产品”。

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.

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

  2. Click Sign in to view GitHub....

    Signing in to view Codespaces

  3. To authorize Visual Studio Code to access your account on GitHub, click Allow.

  4. Sign in to GitHub to approve the extension.

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

  2. Use the "REMOTE EXPLORER" drop-down, then click GitHub Codespaces.

    The Codespaces header

  3. Click Sign in to view Codespaces....

    Signing in to view Codespaces

  4. To authorize Visual Studio Code to access your account on GitHub, click Allow.

  5. Sign in to GitHub to approve the extension.

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.

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

  2. 单击 Add(添加)图标,然后单击 Create New Codespace(创建新代码空间)

    Codespaces 中的 Create new Codespace(创建新代码空间)选项

  3. 键入,然后单击要在其中开发仓库的名称。

    搜索仓库以创建新的 Codespaces

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

    搜索分支以创建新的 Codespaces

  5. Click the machine type you want to develop in.

    新 Codespaces 的实例类型

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

Opening a codespace in Visual Studio Code

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

  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

Changing the machine type in Visual Studio Code

您可以在选择的远程机器上运行代码空间,从 2 核到 32 核。 每种类型都有不同的资源水平和不同的计费等级。 相关信息请参阅“关于代码空间的计费”。

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

    Searching for a branch to create a new Codespaces

  3. Click the codespace that you want to change.

    Searching for a branch to create a new Codespaces

  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

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

  2. 在“Codespaces(代码空间)”下,右键点击您要删除的代码空间。

  3. 在下拉菜单中,单击 Delete Codespace(删除代码空间)

    在 GitHub 中删除代码空间

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

    Clicking on "Insiders Build" in Codespaces

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