JetBrains IDE で GitHub Codespaces を使う

JetBrains IDE 内の Codespaces について

JetBrains IDE を使ってコードを処理する場合、codespace での作業を利用できます。 これを行うには、JetBrains Gateway アプリケーションを使います。

JetBrains Gateway をインストールした後、JetBrains を既定のエディターとして設定すると、GitHub.com から codespace を開くたびに JetBrains Gateway が起動し、お使いの JetBrains IDE を選んで codespace に接続できるようになります。

JetBrains リモート開発接続プロセス

JetBrains IDE で codespace を使う基本的なプロセスは次のとおりです。

• JetBrains Gateway アプリケーションで、アクティブまたは停止している codespace の 1 つを選びます。
• 次に、使う JetBrains IDE を選びます。
• 選んだ JetBrains IDE が、codespace とソース コードをホストするリモート仮想マシンにダウンロードされます。
• JetBrains シン クライアント アプリケーションがローカル コンピューターにダウンロードされ、起動されます。
• クライアント アプリケーションは、完全なバックエンド IDE に接続します。
• ローカル環境の場合と同じ方法で、クライアント アプリケーションでコードを処理できます。

前提条件

JetBrains IDE 内の codespace で作業するには、次のものが必要です。

• 有効な JetBrains ライセンス
• JetBrains Gateway アプリケーション
• GitHub CLI version 2.18.0 以降
• SSH サーバーを実行している既存の codespace

JetBrains ライセンス

JetBrains Gateway で選んだ IDE をサポートしている JetBrains ライセンスが必要です。

JetBrains Gateway

JetBrains Gateway は、JetBrains Toolbox アプリケーションからインストールして更新できます。

1. JetBrains Toolbox をダウンロードしてインストールします。

2. JetBrains Toolbox を開きます。

3. 使用可能なツールの一覧で Gateway を見つけて、 [インストール] をクリックします。

   

GitHub CLI

JetBrains Gateway の GitHub Codespaces プラグインを使うには、JetBrains Gateway から codespace を開く前に、GitHub CLI バージョン 2.18.0 以降をインストールして構成しておく必要があります。

次のコマンドを使用して、GitHub CLI のバージョンを確認します。

gh --version

詳しくは、「GitHub CLI について」を参照してください。

SSH サーバーを実行する codespace

接続先の既存の codespace が必要です。 codespace は、GitHub.com、Visual Studio Code、または GitHub CLI を使用して作成できます。 詳しくは、「リポジトリの codespace を作成する」をご覧ください。

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

"features": {
    ...
    "ghcr.io/devcontainers/features/sshd:1": {
        "version": "latest"
    },
    ...
}

devcontainer.json ファイルと既定のコンテナー イメージについて詳しくは、「開発コンテナーの概要」をご覧ください。

JetBrains Gateway を設定する

GitHub Codespaces に JetBrains Gateway を初めて使う際は、Codespaces プラグインをインストールする必要があります。 また、GitHub アカウントを使って、JetBrains Gateway から GitHub.com へのアクセスを許可する必要があります。

1. JetBrains Gateway アプリケーションを開きます。

2. [その他のプロバイダーのインストール] で、GitHub Codespaces の [インストール] リンクをクリックします。

   

3. [codespace に接続] をクリックします。

   

4. [JetBrains Gateway へようこそ] ダイアログで、 [GitHub でサインイン] をクリックします。

5. ワンタイム コードの横にあるアイコンをクリックしてコピーし、ログイン リンクをクリックします。

   

6. 現在 GitHub にサインインしていない場合、サインイン ページが表示されます。

   • 詳細を入力し、 [サインイン] をクリックします。
   • たとえば、2 要素認証コードを入力して、認証を確認します。

7. [デバイスのアクティブ化] ページで、コピーしたコードを貼り付け、 [続行] をクリックします。

8. 組織に所属している場合は、"組織へのシングル サインオン" ページが表示されます。 JetBrains Gateway からアクセスすることを承認する組織の横にある [承認] をクリックし、 [続行] をクリックします。

9. [JetBrains の GitHub Codespaces の承認] ページで、 [GitHub の承認] をクリックします。

10. JetBrains Gateway アプリケーションに戻り、現在アクティブまたは停止している codespace の一覧から codespace を開き、次の手順のステップ 3 を参照してください。

JetBrains IDE で codespace を開く

JetBrains Gateway を既定のエディターとして設定している場合、GitHub.com から codespace を開くと、Gateway が自動的に起動します。

JetBrains Gateway が既定のエディターではない場合でも、github.com/codespaces にある [あなたの Codespaces] ページに移動し、開く codespace の右側にある省略記号 (...) をクリックすることによって、JetBrains で codespace を開くことができます。 詳しくは、「既存の codespace を開く」を参照してください。

または、JetBrains Gateway を開き、次の手順で説明するように、既存の codespace を選ぶこともできます。

1. JetBrains Gateway アプリケーションを開きます。

2. [Codespaces に接続する] をクリックします。

   

3. [あなたの Codespaces] リストで、作業する codespace をクリックします。

   

4. "使用可能な IDE" リストで、使用する JetBrains IDE をクリックします。 Gateway は、次回 codespace に接続するときのために、選んだ項目を記憶します。

   

5. [Connect] をクリックします。

   注:

   • JetBrains IDE として Rider を選び、リポジトリに複数のソリューション ファイルが含まれている場合は、[ソリューション パスの設定] ダイアログが表示され、作業するソリューションを選ぶように求められます。 ドロップダウン メニューからソリューション ファイルを選び、 [OK] をクリックします。

     リポジトリにソリューション ファイルが含まれていない場合、Rider は基本プロジェクト ディレクトリ ビューで開き、機能が制限されます。 たとえば、.NET 固有のコード ナビゲーションは取得できません。 リポジトリに 1 つのソリューション ファイルしかない場合は、それが自動的に使用され、プロンプトは表示されません。 詳しくは、JetBrains ドキュメントの「プロジェクトとソリューションを作成して開く (Create and open projects and solutions)」をご覧ください。
     
     

   • ファイアウォールを実行している場合、リモート リソースに初めて接続するときに、お使いのネットワーク経由での JetBrains Gateway による通信を許可するように求められる場合があります。

   codespace に初めて接続すると、バックエンド IDE がリモート コンピューターにダウンロードされます。 これには数分かかることがあります。 次に同じ codespace に接続する際、このステップは必要なく、接続プロセスが迅速になります。

   その後、バックエンド IDE が開始されます。 繰り返しになりますが、実行したままのバックエンド IDE に再接続する場合、このステップは今後は必要ありません。

   クライアント アプリケーションが起動します。

参考資料

• 「codespace で開発する」
• JetBrains 用の GitHub Codespaces プラグインの使用
• 「GitHub Codespaces クライアントのトラブルシューティング」