Schnellstart: GitHub CLI

Informationen zu GitHub CLI

GitHub CLI ist ein Open-Source-Tool zur Verwendung von GitHub über die Befehlszeile deines Computers. Wenn du über die Befehlszeile arbeitest, kannst du die GitHub CLI verwenden, um Zeit zu sparen und Kontextwechsel zu vermeiden.

Voraussetzungen

Installiere GitHub CLI unter macOS, Windows oder Linux. Weitere Informationen finden Sie unter Installation im Repository GitHub CLI.
Führe den folgenden Befehl im Terminal aus, um dich bei GitHub zu authentifizieren.
```
gh auth login
```
Wähle aus, wo du dich authentifizieren möchtest:
- Wenn du über GitHub.com auf GitHub zugreifst, wähle GitHub.com aus.
- Wenn du über eine andere Domäne auf GitHub zugreifst, wähle Other aus, und gib dann den Hostnamen ein, z. B. octocorp.ghe.com.
Befolge die restlichen Anweisungen auf dem Bildschirm.

GitHub CLI speichert automatisch Ihre Git-Anmeldeinformationen für Sie, wenn Sie HTTPS als bevorzugtes Protokoll für Git-Operationen auswählen und die Frage, ob Sie sich bei Git mit Ihren GitHub-Anmeldeinformationen authentifizieren möchten, mit „Ja“ beantworten. Dies kann nützlich sein, da Sie damit Git-Befehle wie git push und git pull verwenden können, ohne eine separate Anmeldeinformationsverwaltung einrichten oder SSH verwenden zu müssen.

Einige hilfreiche Befehle

Hinweis

Wenn du einige Befehle zum ersten Mal verwendest – beispielsweise gh codespace SUBCOMMAND – wirst du aufgefordert, deinem Authentifizierungstoken zusätzliche Bereiche hinzuzufügen. Folgen Sie den Anweisungen auf dem Bildschirm.

Ihren Status anzeigen

Geben Sie gh status ein, um Details Ihrer aktuellen Arbeit zu GitHub in allen Repositorys anzuzeigen, die Sie abonniert haben.

Ein Repository anzeigen

Geben Sie gh repo view OWNER/REPO ein, um die Repositorybeschreibung anzuzeigen und README.md für das Repository. Geben Sie gh repo view OWNER/REPO --web ein, um das Repository in Ihrem Standardbrowser anzuzeigen.

Wenn Sie den Unterbefehl repo aus dem Verzeichnis eines lokalen Git-Repositorys ausführen, das über eine Remoteverbindung mitGitHub verfügt, können Sie OWNER/REPO auslassen.

Klonen eines Repositorys

Geben Sie gh repo clone OWNER/REPO ein. Beispielsweise klont gh repo clone octo-org/octo-repo das octo-org/octo-repo-Repository in das Verzeichnis, von dem aus Sie diesen Befehl auf Ihrem lokalen Computer ausgeführt haben.

Repository erstellen

Geben Sie gh repo create ein und befolgen Sie dann die angezeigten Anweisungen. Sie können ein neues, leeres Repository für GitHub erstellen und es dann optional lokal klonen. Alternativ können Sie ein vorhandenes lokales Repository an GitHub übertragen und optional als Remote für Ihr lokales Repository festlegen. Informationen zum Festlegen eines lokalen Verzeichnisses als Git-Repository findest du unter Hinzufügen von lokal gehostetem Code zu GitHub.

Arbeiten mit Sachverhalten

Geben Sie gh issue list --repo OWNER/REPO ein, um die zuletzt erstellten Probleme aufzulisten, die derzeit für das angegebene Repository geöffnet sind. Wenn Sie den Unterbefehl issue aus dem Verzeichnis eines lokalen Git-Repositorys ausführen, das über eine Remoteverbindung mitGitHub verfügt, können Sie --repo OWNER/REPO auslassen. Geben Sie zum Beispiel gh issue list --assignee "@me" ein, um die Ihnen in diesem Repository zugewiesenen Sachverhalte aufzulisten oder gh issue list --author monalisa, um Probleme auflzulisten, die vom Benutzer „monalisa“ erstellt wurden.

Du kannst auch eine neue Ausgabe erstellen, siehe Einen Issue erstellen, oder nach einer Ausgabe suchen, siehe Filtern und Suchen von Problemen und Pull-Anforderungen.

Arbeiten mit Pull Requests

Geben Sie gh pr list --repo OWNER/REPO ein, um die zuletzt erstellten Pull Requests aufzulisten, die derzeit für das angegebene Repository geöffnet sind. Wenn Sie den Unterbefehl pr aus dem Verzeichnis eines lokalen Git-Repositorys ausführen, das über eine Remoteverbindung mitGitHub verfügt, können Sie --repo OWNER/REPO auslassen. Geben Sie beispielsweise gh pr list --author "@me" ein, um offene Pull Requests aufzulisten, die Sie in diesem Repository erstellt haben.

Geben Sie gh pr list --label LABEL-NAME ein, um offene Pull Requests mit einer bestimmten Bezeichnung aufzulisten. Geben Sie gh search prs --review-requested=@me --state=open für Pull-Requests ein, zu deren Überprüfung Sie aufgefordert wurden.

Um eine Pull Request zu erstellen, geben Sie gh pr create ein und folgen Sie den Anweisungen auf dem Bildschirm. Weitere Informationen finden Sie unter Erstellen eines Pull Requests.

Arbeiten mit Codespaces

Um einen neuen Codespace zu erstellen, geben Sie gh codespace create ein und folgen Sie den Anweisungen auf dem Bildschirm.

Um Ihre vorhandenen Codepaces anzuzeigen, geben Sie gh codespace list ein. Um einen Codespace in der Webversion von VS Code zu öffnen, geben Sie gh codespace code -w ein und wählen Sie einen Codespace aus.

In all diesen Befehlen können Sie cs durch codespace ersetzen.

Hilfe

Geben Sie gh ein, um eine Erinnerung an die GitHub CLI-Befehle der obersten Ebene zu erhalten, die Sie verwenden können. Beispiele: issue, pr, repo und so weiter

Für jeden Befehl und jeden untergeordneten Unterbefehl können Sie die Kennzeichnung --help anhängen, um herauszufinden, wie er verwendet wird. Zum Beispiel: gh issue --help oder gh issue create --help.

Anpassen von GitHub CLI

Sie können die Konfigurationseinstellungen ändern und Aliase oder Erweiterungen hinzufügen, damit GitHub CLI so funktioniert, wie es für Sie am geeignetsten ist.

Geben Sie gh config set SUBCOMMANDS ein, um GitHub CLI Einstellungen zu konfigurieren, und ersetzen Sie SUBCOMMANDS durch die Einstellung, die Sie anpassen möchten.

Sie können beispielsweise den Texteditor angeben, der verwendet wird, wenn ein Befehl vom Typ GitHub CLI eine Textbearbeitung erfordert, etwa wenn Sie den Textkörper für einen neuen Sachverhalt hinzufügen, den Sie erstellen. Geben Sie gh config set editor "code -w" ein, um ihren bevorzugten Text-Editor auf Visual Studio Code festzulegen. Die Kennzeichnung -w (oder --wait) in diesem Beispiel bewirkt, dass der Befehl darauf wartet, dass die Datei in Visual Studio Code geschlossen wird, bevor er mit dem nächsten Schritt in Ihrem Terminal fortfährt.

Weitere Informationen finden Sie unter gh config set.
Definiere Aliase für Befehle, die du häufig ausführst. Wenn du z. B. gh alias set prd "pr create --draft" ausführst, kannst du gh prd ausführen, um schnell einen Entwurfs-Pull Request zu öffnen. Weitere Informationen finden Sie unter gh alias.
Erstelle benutzerdefinierte Befehle mit GitHub CLI-Erweiterungen, oder füge sie hinzu. Weitere Informationen findest du unter Verwenden von GitHub CLI-Erweiterungen und Erstellen von GitHub CLI-Erweiterungen.

Verwenden der GitHub CLI mit mehreren Konten

Wenn du über mehrere Konten auf derselben GitHub-Plattform verfügst, z. B. auf GitHub.com, kannst du dich bei allen authentifizieren und mit dem Befehl gh auth switch zwischen ihnen wechseln. Weitere Informationen dazu findest du unter gh switch im Leitfaden zur GitHub CLI.

Wenn du die GitHub CLI für mehrere GitHub-Plattformen verwenden musst, z. B. ein persönliches Konto auf GitHub.com und einen verwaltetes Benutzerkonto auf GHE.com, findest du entsprechende Informationen dazu unter Verwenden der GitHub CLI auf GitHub-Plattformen.

Weiterführende Themen

        [AUTOTITLE](/github-cli/github-cli/github-cli-reference)

        [GitHub CLI Online-Handbuch](https://cli.github.com/manual/gh)

In diesem Artikel