Verwenden von GitHub Codespaces in der JetBrains-IDE

Informationen zu Codespaces in JetBrains-IDEs

Wenn du eine JetBrains-IDE zum Arbeiten an deinem Code verwendest, kannst du die Vorteile des Arbeitens in einem Codespace nutzen. Hierfür wird die JetBrains Gateway-Anwendung verwendet.

Nach der Installation von JetBrains Gateway kannst du JetBrains als Standard-Editor festlegen. Wenn du anschließend einen Codespace über GitHub.com öffnest, wird immer JetBrains Gateway gestartet, und du kannst deine JetBrains-IDE auswählen und eine Verbindung zum Codespace herstellen.

Verbindungsherstellung mit JetBrains für die Remoteentwicklung

Du kannst einen Codespace folgendermaßen in deiner JetBrains-IDE verwenden:

• Wähle in der JetBrains Gateway-Anwendung einen aktiven oder beendeten Codespace aus.
• Wähle anschließend aus, welche JetBrains-IDE verwendet werden soll.
• Die ausgewählte JetBrains-IDE wird dann auf den virtuellen Remotecomputer heruntergeladen, der deinen Codespace und den Quellcode hostet.
• Die schlanke JetBrains-Clientanwendung wird dann auf den lokalen Computer heruntergeladen und gestartet.
• Die Clientanwendung stellt eine Verbindung mit der vollständigen Back-End-IDE her.
• Du kannst in der Clientanwendung genau wie in einer lokalen Umgebung an deinem Code arbeiten.

Voraussetzungen

Du benötigst Folgendes, um in einem Codespaces in einer JetBrains-IDE zu arbeiten:

• Eine gültige JetBrains-Lizenz
• Die JetBrains Gateway-Anwendung
• GitHub CLI 2.18.0 oder höher
• Einen vorhandenen Codespace, der einen SSH-Server ausführt

JetBrains-Lizenz

Du benötigst eine Lizenz für mindestens eine der unterstützten JetBrains-IDEs, um über JetBrains Gateway eine Verbindung mit einem Codespace herzustellen.

JetBrains Gateway

Du kannst JetBrains Gateway über die Anwendung „JetBrains Toolbox“ installieren und aktualisieren.

1. Lade JetBrains Toolbox herunter, und installiere die Anwendung.

2. Öffne JetBrains Toolbox.

3. Suche in der Liste der verfügbaren Tools nach Gateway, und klicke auf Installieren.

   

GitHub CLI

Das GitHub Codespaces-Plug-In für JetBrains Gateway erfordert, dass GitHub CLI 2.18.0 oder höher installiert und konfiguriert ist, bevor ein Codespace über JetBrains Gateway geöffnet werden kann.

Verwende diesen Befehl, um die Version von GitHub CLI zu überprüfen:

gh --version

Weitere Informationen findest du unter Informationen zur GitHub-CLI.

Codespace mit ausgeführtem SSH-Server

Es muss ein Codespace vorhanden sein, mit dem eine Verbindung hergestellt werden kann. Du kannst einen Codespace auf GitHub.com, in Visual Studio Code oder mit der GitHub CLI erstellen. Weitere Informationen findest du unter Erstellen eines Codespaces für ein Repository.

Der Codespace, mit dem du eine Verbindung herstellst, muss einen SSH-Server ausführen. Das Standardcontainerimage enthält einen SSH-Server, der automatisch gestartet wird. Wenn deine Codespaces nicht mithilfe des Standardimages erstellt werden, kannst du einen SSH-Server installieren und starten, indem du dem features-Objekt in deiner devcontainer.json-Datei Folgendes hinzufügst:

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

Weitere Informationen zur Datei devcontainer.json und dem Standardcontainerimage findest du unter Einführung in Entwicklungscontainer.

Einrichten von JetBrains Gateway

Wenn du JetBrains Gateway zum ersten Mal für GitHub Codespaces verwendest, musst du das Codespaces-Plug-In installieren. Außerdem musst du JetBrains Gateway den Zugriff auf GitHub.com über dein GitHub-Konto gestatten.

1. Öffne die Anwendung „JetBrains Gateway“.

2. Klicke unter Weitere Anbieter installieren auf den Installationslink für GitHub Codespaces.

   

3. Klicke auf Mit Codespace verbinden.

   

4. Klicke im Dialogfeld „Willkommen bei JetBrains Gateway“ auf Mit GitHub anmelden.

   

5. Klicke auf das Symbol neben dem einmaligen Code, um ihn zu kopieren, und klicke dann auf den Anmeldelink.

   

6. Wenn du derzeit nicht bei GitHub angemeldet bist, wird die Anmeldeseite angezeigt.

   • Gib deine Anmeldedaten ein, und klicke auf Anmelden.
   • Authentifiziere dich, zum Beispiel durch die Eingabe eines Zwei-Faktor-Authentifizierungscodes.

7. Füge auf der Seite „Geräteaktivierung“ den kopierten Code ein, und klicke auf Weiter.

8. Wenn du Organisationen angehörst, klicke auf der angezeigten Seite auf „Einmaliges Anmelden bei deiner Organisation“. Klicke neben den Organisationen, für die der Zugriff durch JetBrains Gateway autorisiert werden soll, auf Autorisieren. Klicke dann auf Weiter.

9. Klicke auf der Seite „GitHub Codespaces für JetBrains autorisieren“ auf GitHub autorisieren.

10. Kehre zur JetBrains Gateway-Anwendung zurück, und öffne einen Codespace aus der Liste der derzeit aktiven oder beendeten Codespaces. Weitere Informationen findest du in Schritt 3 des folgenden Verfahrens.

Öffnen eines Codespaces in deiner JetBrains-IDE

Wenn du das JetBrains-Gateway als Standard-Editor festgelegt hast, wird das Gateway automatisch gestartet, wenn du einen Codespace aus GitHub.com öffnest.

Wenn das JetBrains-Gateway nicht dein Standard-Editor ist, kannst du dennoch einen Codespace in JetBrains öffnen, indem du unter github.com/codespaces zur Seite „Deine Codespaces“ wechselst und rechts neben dem Codespace, den du öffnen möchtest, auf die Auslassungspunkte (...) klickst. Weitere Informationen findest du unter Öffnen eines vorhandenen Codespaces.

Alternativ kannst du auch das JetBrains-Gateway öffnen und einen vorhandenen Codespace auswählen, wie im folgenden Verfahren beschrieben.

1. Öffne die Anwendung JetBrains Gateway.

2. Klicke auf Mit Codespaces verbinden.

   

3. Klicke in der Liste „Deine Codespaces“ auf den Codespace, in dem du arbeiten möchtest.

   

4. Klicke in der Liste „Verfügbare IDEs“ auf die JetBrains-IDE, die du verwenden möchtest. Das Gateway speichert deine Auswahl, wenn du das nächste Mal eine Verbindung mit einem Codespace herstellst.

   

5. Klicke auf Verbinden.

   Hinweis: Beim Ausführen einer Firewall: Wenn du zum ersten Mal eine Verbindung mit einer Remoteressource herstellst, wirst du möglicherweise aufgefordert, JetBrains Gateway für die Kommunikation über dein Netzwerk zuzulassen.

   Wenn du zum ersten Mal eine Verbindung mit einem Codespace herstellst, wird die Back-End-IDE auf den Remotecomputer heruntergeladen. Dies kann einige Minuten dauern. Wenn du das nächste Mal eine Verbindung mit demselben Codespace herstellst, ist dieser Schritt nicht erforderlich, sodass der Verbindungsvorgang beschleunigt wird.

   Anschließend wird die Back-End-IDE gestartet. Auch dieser Schritt ist in Zukunft nicht erforderlich, wenn du eine Verbindung mit einer Back-End-IDE herstellst, die noch ausgeführt wird.

   Dann wird die Clientanwendung gestartet.

Weitere nützliche Informationen

• Entwicklung in einem Codespace
• Verwenden des GitHub Codespaces-Plug-Ins für JetBrains
• Verwenden von GitHub Copilot in GitHub Codespaces
• Problembehandlung für GitHub Codespaces-Clients