Skip to main content

Using GitHub 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 Enterprise Cloud.

GitHub Codespaces está disponible para las organizaciones que usen GitHub Team o GitHub Enterprise Cloud. GitHub Codespaces también está disponible como versión beta limitada para usuarios individuales en los planes GitHub Free y GitHub Pro. Para más información, vea "Productos de GitHub".

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 GitHub 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 GitHub Codespaces extension with your GitHub Enterprise Cloud credentials. The GitHub Codespaces extension requires VS Code October 2020 Release 1.51 or later.

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

  1. En VS Code, en la barra lateral izquierda, haz clic en el icono de Explorador Remoto.

    El icono de Remote Explorer (Explorador remoto) en Visual Studio Code

    Nota: Si el Explorador remoto no se muestra en la barra de actividad:

    1. Abra la paleta de comandos. Por ejemplo, presionando el Comando+Shift+P (Mac) / Ctrl+Shift+P (Windows/Linux).
    2. Escriba: codespaces.
    3. Haz clic en Codespaces: Detalles.
  2. Click Sign in to view GitHub....

    Signing in to view GitHub Codespaces

  3. To authorize VS Code to access your account on GitHub Enterprise Cloud, click Allow.

  4. Sign in to GitHub Enterprise Cloud to approve the extension.

  1. En VS Code, en la barra lateral izquierda, haz clic en el icono de Explorador Remoto.

    El icono de Remote Explorer (Explorador remoto) en Visual Studio Code

    Nota: Si el Explorador remoto no se muestra en la barra de actividad:

    1. Abra la paleta de comandos. Por ejemplo, presionando el Comando+Shift+P (Mac) / Ctrl+Shift+P (Windows/Linux).
    2. Escriba: codespaces.
    3. Haz clic en Codespaces: Detalles.
  2. Use the "REMOTE EXPLORER" drop-down, then click GitHub Codespaces.

    The GitHub Codespaces header

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

    Signing in to view GitHub Codespaces

  4. To authorize VS Code to access your account on GitHub Enterprise Cloud, click Allow.

  5. Sign in to GitHub Enterprise Cloud to approve the extension.

Creating a codespace in VS 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 VS Code Marketplace marketplace.

Note: Currently, VS Code doesn't allow you to choose a dev container configuration when you create a codespace. If you want to choose a specific dev container configuration, use the GitHub web interface to create your codespace. For more information, click the Web browser tab at the top of this page.

  1. En VS Code, en la barra lateral izquierda, haz clic en el icono de Explorador Remoto.

    El icono de Remote Explorer (Explorador remoto) en Visual Studio Code

    Nota: Si el Explorador remoto no se muestra en la barra de actividad:

    1. Abra la paleta de comandos. Por ejemplo, presionando el Comando+Shift+P (Mac) / Ctrl+Shift+P (Windows/Linux).
    2. Escriba: codespaces.
    3. Haz clic en Codespaces: Detalles.
  2. Click the Add icon: .

    The Create new Codespace option in GitHub Codespaces

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

    Searching for repository to create a new codespace

  4. Click the branch you want to develop on.

    Searching for a branch to create a new codespace

  5. If prompted to choose a dev container configuration file, choose a file from the list.

    Choosing a dev container configuration file for GitHub Codespaces

  6. Click the machine type you want to use.

    Instance types for a new codespace

    Note: Tu elección de los tipos de máquina disponibles podría estar limitada por una directiva configurada para la organización o por una especificación mínima del tipo de máquina para el repositorio. Para más información, vea "Restricción del acceso a los tipos de máquina" y "Configuración de una especificación mínima para las máquinas de los codespaces".

Opening a codespace in VS Code

  1. En VS Code, en la barra lateral izquierda, haz clic en el icono de Explorador Remoto.

    El icono de Remote Explorer (Explorador remoto) en Visual Studio Code

    Nota: Si el Explorador remoto no se muestra en la barra de actividad:

    1. Abra la paleta de comandos. Por ejemplo, presionando el Comando+Shift+P (Mac) / Ctrl+Shift+P (Windows/Linux).
    2. Escriba: codespaces.
    3. Haz clic en Codespaces: Detalles.
  2. Under "Codespaces", click the codespace you want to develop in.

  3. Click the Connect to Codespace icon.

    The Connect to Codespace icon in VS Code

Changing the machine type in VS Code

Normalmente, puedes ejecutar tu codespace en la máquina remota de tu elección, desde 2 hasta 32 núcleos. Cada una de estas tiene un nivel de recursos y de facturación diferentes. Para obtener información, consulta "Acerca de la facturación de GitHub Codespaces".

De forma predeterminada, al crear un codespace se utiliza el tipo de máquina con los recursos válidos más bajos. 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."

    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: Tu elección de los tipos de máquina disponibles podría estar limitada por una directiva configurada para la organización o por una especificación mínima del tipo de máquina para el repositorio. Para más información, vea "Restricción del acceso a los tipos de máquina" y "Configuración de una especificación mínima para las máquinas de los codespaces".

  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

Puedes eliminar codespaces desde VS Code cuando no estás trabajando actualmente en un codespace.

  1. En VS Code, en la barra lateral izquierda, haz clic en el icono de Explorador Remoto.

    El icono de Remote Explorer (Explorador remoto) en Visual Studio Code

    Nota: Si el Explorador remoto no se muestra en la barra de actividad:

    1. Abra la paleta de comandos. Por ejemplo, presionando el Comando+Shift+P (Mac) / Ctrl+Shift+P (Windows/Linux).
    2. Escriba: codespaces.
    3. Haz clic en Codespaces: Detalles.
  2. En "CODESPACES DE GITHUB", haz clic con el botón derecho en el codespace que quieras eliminar.

  3. Haz clic en Eliminar codespace.

    Borrar un codespace en GitHub

Switching to the Insiders build of VS Code

You can use the Insiders Build of VS Code within GitHub Codespaces.

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

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

    Clicking on "Insiders Build" in GitHub Codespaces

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