Skip to main content

Setting your default editor for GitHub Codespaces

個人用設定ページで、Codespaces の既定のエディターを設定できます。

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:

  • Visual Studio Code (desktop application)
  • Visual Studio Code (web client application)
  • JetBrains Gateway - for opening codespaces in a JetBrains IDE
  • JupyterLab - the web interface for Project Jupyter

新しい codespace をテンプレートから作成すると、常に Visual Studio Code Web クライアントで開きます。 サポートされているエディターでは、既存の codespace を開くことができます。 詳しくは、「既存の codespace を開く」を参照してください。

If you want to use Visual Studio Code as your default editor for GitHub Codespaces, you need to install Visual Studio Code and the GitHub Codespaces extension for Visual Studio Code. For more information, see the download page for Visual Studio Code and the GitHub Codespaces extension on the Visual Studio Code marketplace.

If you want to work on a codespace in a JetBrains IDE you must install the JetBrains Gateway. For more information, see "JetBrains IDE で GitHub Codespaces を使う."

Setting your default editor

  1. 任意のページで、右上隅にあるプロファイルの画像をクリックし、次に[設定]をクリックします。

    Screenshot of a user's account menu on GitHub. The menu item "Settings" is outlined in dark orange.

  2. サイドバーの [コード、プラン、自動化] セクションで、[ Codespaces] をクリックします。

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

    Screenshot of the "Editor preference" options, with "Visual Studio Code for Web" selected.

    • Visual Studio Code または JetBrains Gateway を選ぶ場合、選んだアプリケーションをローカル コンピューターにインストールしていることを確認する必要があります。

    • If you choose Visual Studio Code, 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 Visual Studio Code for it to open successfully.

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

    • 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 "JetBrains IDE で GitHub Codespaces を使う."

      To connect to a codespace from the Gateway application, you must have an SSH server running on the codespace. 接続する codespace では、SSH サーバーを実行している必要があります。 既定のコンテナー イメージには、自動的に開始される SSH サーバーが含まれています。 codespaces が既定のイメージから作成されていない場合は、devcontainer.json ファイル内の features オブジェクトに次を追加することで、SSH サーバーをインストールして起動できます。

      "features": {
          // ...
          "ghcr.io/devcontainers/features/sshd:1": {
              "version": "latest"
          },
          // ...
      }
      
    • If you choose JupyterLab, the JupyterLab application must be installed in the codespaces you open. 既定のコンテナー イメージには JupyterLab が含まれているため、既定のイメージから作成された codespace には常に JupyterLab がインストールされます。 既定のイメージの詳細については、「開発コンテナーの概要」と devcontainers/images リポジトリを参照してください。 開発コンテナー構成で既定のイメージを使用していない場合は、devcontainer.json ファイルに ghcr.io/devcontainers/features/python 機能を追加して JupyterLab をインストールできます。 オプション "installJupyterlab": trueを含める必要があります。 詳細については、devcontainers/features リポジトリの python 機能の README を参照してください。

Further reading