GitHub CLI (gh) Skill
Verwenden Sie die gh CLI, um mit GitHub-Repositories, Issues, Pull Requests und GitHub Actions Workflows vom Terminal aus zu interagieren.
Voraussetzungen
Überprüfen Sie, ob gh installiert und authentifiziert ist:
gh --version
gh auth status
Wenn nicht authentifiziert, führen Sie gh auth login aus und folgen Sie den Anweisungen.
Kern-Workflows
Issue-Verwaltung
# Issues auflisten
gh issue list # Offene Issues im aktuellen Repo
gh issue list --state all # Alle Issues (inkl. geschlossene)
gh issue list --assignee @me # Ihnen zugewiesene Issues
gh issue list --label "bug" # Nach Label filtern
# Issue erstellen
gh issue create -t "Titel" -b "Beschreibung"
gh issue create -t "Titel" --label "bug,priority:high" --milestone "milestone-1"
gh issue create # Interaktiver Modus
# Issue anzeigen/aktualisieren
gh issue view 123 # Issue-Details anzeigen
gh issue view 123 --web # Im Browser öffnen
gh issue edit 123 --add-label "in-progress"
gh issue close 123
gh issue reopen 123
# Kommentare hinzufügen
gh issue comment 123 -b "Ich arbeite jetzt daran"
Branch- und Commit-Workflow
# Feature/Fix-Branch erstellen
git checkout -b feature/mein-feature
git checkout -b fix/issue-123
git checkout -b draft/wip-experiment
# Änderungen bereitstellen und committen
git add .
git commit -m "feat: neues Feature hinzufügen"
git commit -m "fix: Problem #123 behoben"
# Branch auf Remote pushen
git push -u origin feature/mein-feature
Pull-Request-Verwaltung
# PR erstellen (mehrere Methoden)
gh pr create # Interaktiver Modus
gh pr create --fill # Automatisch aus Commits befüllen
gh pr create --draft # Als Entwurf erstellen
gh pr create --draft --fill # Entwurf mit automatischer Befüllung
gh pr create -t "Titel" -b "Beschreibung" -B main
gh pr create --label "review-needed" --assignee @me
# PRs auflisten
gh pr list # Offene PRs
gh pr list --assignee @me # Ihre PRs
gh pr list --search "review-requested:@me" # PRs mit Review-Anfrage an Sie
gh pr list --draft # Nur Entwurfs-PRs
# PR-Details anzeigen
gh pr view 45 # PR im Terminal anzeigen
gh pr view 45 --web # Im Browser öffnen
Code-Review-Workflow
# PR lokal zum Testen auschecken
gh pr checkout 45 # PR-Branch lokal auschecken
# Änderungen überprüfen
gh pr diff 45 # PR-Diff anzeigen
gh pr diff # Diff für den aktuellen Branch-PR
# Review-Kommentare hinzufügen
gh pr comment 45 -b "LGTM, kleiner Vorschlag in Zeile 42"
gh pr comment -b "Bitte Tests hinzufügen" # Kommentar zum aktuellen Branch-PR
# Formelles Review einreichen
gh pr review 45 --approve
gh pr review 45 --request-changes -b "Bitte beheben Sie die Fehlerbehandlung"
gh pr review 45 --comment -b "Sieht insgesamt gut aus, ein paar Vorschläge"
# Merge
gh pr merge 45 # Interaktiver Merge
gh pr merge 45 --squash # Squash-Merge
gh pr merge 45 --rebase # Rebase-Merge
gh pr merge 45 --merge # Standard-Merge-Commit
gh pr merge 45 --auto # Auto-Merge, wenn Checks bestanden
Vorhandenen PR aktualisieren
gh pr edit 45 --title "Neuer Titel"
gh pr edit 45 --body "Aktualisierte Beschreibung"
gh pr edit 45 --base develop
gh pr edit 45 --add-label "ready-for-review"
gh pr ready 45 # Als bereit markieren (Entwurf entfernen)
GitHub Actions Workflow-Verwaltung
# Workflow-Läufe auflisten
gh run list # Aktuelle Workflow-Läufe
gh run list --workflow=ci.yml # Bestimmter Workflow
gh run list --status=failure # Nur fehlgeschlagene Läufe
# Workflow-Lauf-Details anzeigen
gh run view # Interaktive Laufauswahl
gh run view 12345 # Bestimmter Lauf
gh run view 12345 --web # Im Browser öffnen
# Workflow auslösen
gh workflow run ci.yml # Auf Standard-Branch ausführen
gh workflow run ci.yml --ref feature/x # Auf bestimmtem Branch ausführen
gh workflow run ci.yml -f key=value # Mit Eingabeparametern
# Fehlgeschlagene Jobs erneut ausführen
gh run rerun 12345 # Alle Jobs erneut ausführen
gh run rerun 12345 --failed # Nur fehlgeschlagene Jobs erneut ausführen
# Job-Logs anzeigen
gh run view 12345 --log # Vollständige Log-Ausgabe
gh run view 12345 --log-failed # Nur Logs fehlgeschlagener Jobs
# Lauf in Echtzeit verfolgen
gh run watch # Aktuellen Lauf verfolgen
gh run watch 12345 # Bestimmten Lauf verfolgen
Allgemeine Flag-Referenz
| Flag | Beschreibung |
|---|---|
-R, --repo OWNER/REPO | Ziel-Repository ändern |
-B, --base | Basis-Branch für den PR |
-H, --head | Kopf-Branch für den PR |
-t, --title | Titel für Issue/PR |
-b, --body | Beschreibung für Issue/PR |
-l, --label | Labels (kommasepariert) |
-a, --assignee | Zugewiesener Benutzer |
-m, --milestone | Meilenstein-Name |
--draft | Als Entwurfs-PR erstellen |
--fill | Automatisch aus Commit-Nachrichten befüllen |
--web | Im Browser öffnen |
-y, --yes | Bestätigungsaufforderungen überspringen |
Umgebungsvariablen
export GH_TOKEN="ghp_xxxx" # Personal Access Token
export GH_HOST="github.example.com" # GitHub Enterprise-Instanz
export GH_REPO="owner/repo" # Standard-Repository
Tipps und Fallstricke
Mehrzeilige Beschreibungen mit Markdown
Wenn Sie Issues oder PRs mit langen Beschreibungen erstellen, die Markdown enthalten (Codeblöcke, Backticks), vermeiden Sie Heredocs, die aufgrund der Shell-Interpretation fehlschlagen können. Stattdessen:
# Schritt 1: Beschreibung in eine temporäre Datei schreiben (außerhalb von bash)
# Schritt 2: Aus der temporären Datei erstellen
gh issue create -t "Titel" -b "$(cat temp_description.txt)"
# Schritt 3: Aufräumen
rm temp_description.txt
Dies vermeidet Probleme mit:
- Backticks in Codeblöcken, die mit der Befehlsersetzung kollidieren
- Sonderzeichen, die von der Shell interpretiert werden
- Heredoc-Delimiter-Konflikten
Beschreibung aus vorhandenen Dateien einlesen
Um ein Issue oder einen PR aus einer Markdown-Plan-Datei zu erstellen:
# Verwenden Sie den body-file-Flag für saubere dateibasierte Beschreibungen
gh issue create -t "Titel" --body-file docs/plans/mein-plan.md
gh pr create -t "Titel" --body-file docs/plans/mein-plan.md
Detaillierte Referenz
Eine umfassende Übersicht über Befehlsoptionen und Beispiele finden Sie unter references/commands.md.