1
0
mirror of synced 2025-12-21 02:46:50 -05:00
Files
docs/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md
Isaac Brown 31274d9415 [Universe] - Codespaces Templates - combined work (#32149)
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: JP Ungaretti <19893438+jungaretti@users.noreply.github.com>
2022-11-03 13:30:55 +00:00

3.5 KiB

title, shortTitle, intro, versions, redirect_from, topics, type
title shortTitle intro versions redirect_from topics type
Setting your default editor for GitHub Codespaces Set the default editor {% data reusables.codespaces.about-changing-default-editor %}
fpt ghec
* *
/codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces
/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces
Codespaces
how_to

On the settings page, you can set your editor preference so that when you create a codespace, or open an existing codespace, it is opened in your choice of:

  • {% data variables.product.prodname_vscode %} (desktop application)
  • {% data variables.product.prodname_vscode %} (web client application)
  • JetBrains Gateway - for opening codespaces in a JetBrains IDE
  • JupyterLab - the web interface for Project Jupyter

{% data reusables.codespaces.template-codespaces-default-editor %}

If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_github_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the download page for {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace.

If you want to work on a codespace in a JetBrains IDE you must install the JetBrains Gateway. For more information, see "Using Codespaces in your JetBrains IDE."

Setting your default editor

{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %}

  1. Under "Editor preference", select the option you want.

    Setting your editor

    • {% data reusables.codespaces.application-installed-locally %}

    • If you choose {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_github_codespaces %} will automatically open in the desktop application when you next create or open a codespace.

      You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully.

    • If you choose JetBrains Gateway, the Gateway application will automatically open when you next create or open a codespace.

      The first time you open a codespace this way you must give permission to open the application.

      The Gateway application will open and the codespace will then be automatically selected. You can then choose a JetBrains IDE, if you have not previously done so, and click Connect to open the codespace in the JetBrains client. For more information, see "Using Codespaces in your JetBrains IDE."

      To connect to a codespace from the Gateway application, you must have an SSH server running on the codespace. {% indented_data_reference reusables.codespaces.ssh-server-installed spaces=5 %}

    • If you choose JupyterLab, the JupyterLab application must be installed in the codespaces you open. {% data reusables.codespaces.jupyterlab-in-default-image %}