1
0
mirror of synced 2025-12-20 10:28:40 -05:00
Files
docs/content/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code.md
2022-05-31 11:54:28 +02:00

7.2 KiB

title, intro, product, redirect_from, versions, type, topics, shortTitle
title intro product redirect_from versions type topics shortTitle
Using GitHub Codespaces in Visual Studio Code You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}. {% data reusables.gated-features.codespaces %}
/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code
/github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code
/github/developing-online-with-codespaces/using-codespaces-in-visual-studio
fpt ghec
* *
how_to
Codespaces
Visual Studio Code
Developer
Visual Studio Code

About {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode %}

You can use your local install of {% data variables.product.prodname_vscode %} to create, manage, work in, and delete codespaces. To use {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode_shortname %}, you need to install the {% data variables.product.prodname_github_codespaces %} extension. For more information on setting up Codespaces in {% data variables.product.prodname_vscode_shortname %}, see "Prerequisites."

By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode_shortname %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode_shortname %}. For more information, see "Setting your default editor for {% data variables.product.prodname_codespaces %}."

If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode_shortname %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "Personalizing {% data variables.product.prodname_codespaces %} for your account."

Prerequisites

To develop in a codespace directly in {% data variables.product.prodname_vscode_shortname %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode_shortname %} October 2020 Release 1.51 or later.

Use the {% data variables.product.prodname_vscode_marketplace %} to install the {% data variables.product.prodname_github_codespaces %} extension. For more information, see Extension Marketplace in the {% data variables.product.prodname_vscode_shortname %} documentation.

{% mac %}

{% data reusables.codespaces.click-remote-explorer-icon-vscode %}

  1. Click Sign in to view {% data variables.product.prodname_dotcom %}....

    Signing in to view {% data variables.product.prodname_codespaces %}

  2. To authorize {% data variables.product.prodname_vscode_shortname %} to access your account on {% data variables.product.product_name %}, click Allow.

  3. Sign in to {% data variables.product.product_name %} to approve the extension.

{% endmac %}

{% windows %}

{% data reusables.codespaces.click-remote-explorer-icon-vscode %}

  1. Use the "REMOTE EXPLORER" drop-down, then click {% data variables.product.prodname_github_codespaces %}.

    The {% data variables.product.prodname_codespaces %} header

  2. Click Sign in to view {% data variables.product.prodname_codespaces %}....

    Signing in to view {% data variables.product.prodname_codespaces %}

  3. To authorize {% data variables.product.prodname_vscode_shortname %} to access your account on {% data variables.product.product_name %}, click Allow.

  4. Sign in to {% data variables.product.product_name %} to approve the extension.

{% endwindows %}

Creating a codespace in {% data variables.product.prodname_vscode_shortname %}

{% data reusables.codespaces.creating-a-codespace-in-vscode %}

Opening a codespace in {% data variables.product.prodname_vscode_shortname %}

{% data reusables.codespaces.click-remote-explorer-icon-vscode %}

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

  2. Click the Connect to Codespace icon.

    The Connect to Codespace icon in {% data variables.product.prodname_vscode_shortname %}

Changing the machine type in {% data variables.product.prodname_vscode_shortname %}

{% data reusables.codespaces.codespaces-machine-types %} You can change the machine type of your codespace at any time.

  1. In {% data variables.product.prodname_vscode_shortname %}, 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 {% data variables.product.prodname_codespaces %}

  3. Click the codespace that you want to change.

    Searching for a branch to create a new {% data variables.product.prodname_codespaces %}

  4. Choose the machine type you want to use.

    {% note %}

    Note: {% data reusables.codespaces.codespaces-machine-type-availability %}

    {% endnote %}

  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 {% data variables.product.prodname_vscode_shortname %}

{% data reusables.codespaces.deleting-a-codespace-in-vscode %}

Switching to the Insiders build of {% data variables.product.prodname_vscode_shortname %}

You can use the Insiders Build of {% data variables.product.prodname_vscode_shortname %} within {% data variables.product.prodname_codespaces %}.

  1. In bottom left of your {% data variables.product.prodname_codespaces %} window, select {% octicon "gear" aria-label="The settings icon" %} Settings.

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

    Clicking on "Insiders Build" in {% data variables.product.prodname_codespaces %}

  3. Once selected, {% data variables.product.prodname_codespaces %} will continue to open in Insiders Version.