Verwenden der GitHub Copilot-CLI

Hier erfährst du, wie du GitHub Copilot über die Befehlszeile verwendest.

Wer kann dieses Feature verwenden?

Die GitHub Copilot-CLI ist mit den GitHub Copilot Pro-, GitHub Copilot Pro+-, GitHub Copilot Business- und GitHub Copilot Enterprise-Plänen verfügbar.

Wenn du Copilot von einer Organisation erhältst, muss die Copilot-CLI-Richtlinie in den Einstellungen der Organisation aktiviert sein.

In diesem Artikel

Über die Befehlszeilenschnittstelle (CLI) für GitHub Copilot kannst du Copilot direkt von deinem Terminal aus verwenden. Weitere Informationen finden Sie unter Informationen zur GitHub Copilot-CLI.

Hinweis

Die GitHub Copilot-CLI befindet sich in der Public Preview. Änderungen sind vorbehalten.

Voraussetzung

Installiere Copilot-CLI. Weitere Informationen findest du unter Installieren der GitHub Copilot-CLI.

Verwenden von Copilot-CLI

  1. Navigiere in deinem Terminal zu einem Ordner, der Code enthält, mit dem du arbeiten möchtest.

  2. Gib copilot ein, um Copilot-CLI zu starten.

    Du wirst durch Copilot aufgefordert, zu bestätigen, dass du den Dateien in diesem Ordner vertraust.

    Wichtig

    Während dieser GitHub Copilot-CLI-Sitzung versucht Copilot möglicherweise, Dateien in und unter diesem Ordner zu lesen, zu ändern und auszuführen. Du solltest den Vorgang nur fortsetzen, wenn du den Dateien an diesem Speicherort vertraust. Weitere Informationen zu vertrauenswürdigen Verzeichnissen findest du unter Informationen zur GitHub Copilot-CLI.

  3. Wählen Sie eine der Optionen:

    1. Yes, proceed:

    Copilot kann nur für diese Sitzung mit den Dateien an diesem Speicherort arbeiten.

    2. Yes, and remember this folder for future sessions:

    Du vertraust den Dateien in diesem Ordner für diese und zukünftige Sitzungen. Du wirst nicht erneut gefragt, wenn du Copilot-CLI aus diesem Ordner startest. Wähle diese Option nur aus, wenn du sicher bist, dass es immer sicher ist, dass Copilot mit Dateien an diesem Speicherort arbeiten.

    3. No, exit (Esc):

    Beende deine Copilot-CLI-Sitzung.

  4. Wenn du derzeit nicht bei GitHub angemeldet bist, wirst du aufgefordert, den Schrägstrichbefehl /login zu verwenden. Gib diesen Befehl ein, und befolge die Anweisungen auf dem Bildschirm, um dich zu authentifizieren.

  5. Gib in der CLI einen Prompt ein.

    Dabei kann es ich um eine einfache Chatfrage oder eine Anforderung von Copilot handeln, um eine bestimmte Aufgabe wie das Beheben eines Fehlers, das Hinzufügen eines Features zu einer vorhandenen Anwendung oder das Erstellen einer neuen Anwendung auszuführen.

    Einige Beispiele für Prompts findest du unter Informationen zur GitHub Copilot-CLI.

  6. Wenn Copilot ein Tool verwenden möchte, das Dateien ändern oder ausführen kann (Beispiel: touch, chmod, node oder sed), wirst du aufgefordert, die Verwendung des Tools zu genehmigen.

    Wählen Sie eine der Optionen:

    1. Yes:

    Lasse zu, dass Copilot dieses Tool verwendet. Wenn Copilot dieses Tool das nächste Mal verwenden möchte, wirst du aufgefordert, es erneut zu genehmigen.

    2. Yes, and approve TOOL for the rest of the running session:

    Lasse zu, dass Copilot dieses Tool mit allen Optionen verwenden kann, ohne den Rest der aktuell ausgeführten Sitzung erneut zu fragen. Du musst den Befehl in zukünftigen Sitzungen erneut genehmigen.

    Die Auswahl dieser Option ist für viele Tools wie chmod hilfreich, da sie verhindert, dass du ähnliche Befehle wiederholt in derselben Sitzung genehmigen musst. Du solltest dir jedoch der Auswirkungen dieser Option auf die Sicherheit bewusst sein. Wenn du diese Option für den Befehl rm auswählst, könnte Copilot beispielsweise jede Datei im aktuellen Ordner oder unter dem aktuellen Ordner löschen, ohne deine Genehmigung anzufordern.

    3. No, and tell Copilot what to do differently (Esc):

    Copilot führt den Befehl nicht aus. Stattdessen wird der aktuelle Vorgang beendet, und der nächste Prompt wird erwartet. Du kannst Copilot anweisen, die Aufgabe fortzusetzen, jedoch einen anderen Ansatz zu verwenden.

    Beispiel: Wenn du Copilot anweist, ein Bash-Skript zu erstellen, das Skript jedoch nicht verwenden möchtest, das Copilot vorschlägt, kannst du den aktuellen Vorgang beenden und einen neuen Prompt Continue the previous task but include usage instructions in the script eingeben.

Tipps

Optimiere deine Verwendung von Copilot-CLI mit den folgenden Tipps.

Beenden eines aktuell ausgeführten Vorgangs

Wenn du einen Prompt eingibst und dann entscheidest, Copilot noch während des „Denkprozesses“ daran zu hindern, die Aufgabe abzuschließen, drücke ESC.

Einschließen einer bestimmten Datei im Prompt

Um deinem Prompt eine bestimmte Datei hinzuzufügen, verwende @ gefolgt vom relativen Pfad zur Datei. Beispiel: Explain @config/ci/ci-required-checks.yml oder Fix the bug in @src/app.js. Dadurch wird der Inhalt der Datei deinem Prompt als Kontext für Copilot hinzugefügt.

Wenn du mit der Eingabe eines Dateipfads beginnst, werden die übereinstimmenden Pfade unterhalb des Promptfelds angezeigt. Verwende die Pfeiltasten, um einen Pfad auszuwählen, und drücke TAB, um den Pfad im Prompt zu vervollständigen.

Arbeiten mit Dateien an einem anderen Speicherort

Um eine Aufgabe abzuschließen, muss Copilot möglicherweise mit Dateien arbeiten, die sich außerhalb des aktuellen Arbeitsverzeichnisses befinden. Wenn Copilot durch einen Prompt, den du in einer interaktiven Sitzung eingegeben hast, eine Datei außerhalb des aktuellen Speicherorts ändern muss, wirst du aufgefordert, den Zugriff auf das Verzeichnis der Datei zu gewähren.

Du kannst ein vertrauenswürdiges Verzeichnis außerdem jederzeit manuell hinzufügen, indem du den Schrägstrichbefehl verwenden:

/add-dir /path/to/directory

Wenn sich alle Dateien, mit denen du arbeiten möchtest, an einem anderen Speicherort befinden, kannst du mithilfe des Schrägstrichbefehls das aktuelle Arbeitsverzeichnis wechseln, ohne eine neue Copilot-CLI-Sitzung zu starten:

/cwd /path/to/directory

Fortsetzen einer interaktiven Sitzung

Du kannst zu einer vorherigen interaktiven Sitzung zurückkehren und deine Unterhaltung mit Copilot fortsetzen, indem du die Befehlszeilenoption --resume verwendest und dann aus der angezeigten Liste die Sitzung auswählst, die du fortsetzen möchtest.

Verwenden benutzerdefinierter Anweisungen

Du kannst die Leistung von Copilot verbessern, indem du dem Repository, in dem du arbeitest, benutzerdefinierte Anweisungen hinzufügst. Benutzerdefinierte Anweisungen sind Beschreibungen in natürlicher Sprache, die in Markdowndateien im Repository gespeichert sind. Sie werden automatisch in Prompts eingeschlossen, die du während der Arbeit in diesem Repository eingibst. Dadurch kann Copilot den Kontext deines Projekts besser verstehen und auf deine Prompts reagieren.

Copilot-CLI unterstützt Folgendes:

  • Repositoryweite Anweisungen in der Datei .github/copilot-instructions.md
  • Pfadspezifische Anweisungsdateien: .github/copilot-instructions/**/*.instructions.md
  • Agent-Dateien wie AGENTS.md

Weitere Informationen finden Sie unter Hinzufügen benutzerdefinierter Repositoryanweisungen für GitHub Copilot.

Hinzufügen eines MCP-Servers

Für Copilot-CLI ist der MCP-Server von GitHub bereits konfiguriert. Mit diesem MCP-Server kannst du beispielsweise mit Ressourcen auf GitHub.com so interagieren, dass du Pull Requests von der CLI mergen kannst.

Du kannst weitere MCP-Server hinzufügen, um die für dich in Copilot-CLI verfügbare Funktionalität zu erweitern:

  1. Verwende den folgenden Schrägstrichbefehl:

    /mcp add

  2. Gib die Details für den MCP-Server ein, den du hinzufügen möchtest, und verwende die TABULATORTASTE, um zwischen Feldern zu wechseln.

  3. Drücke STRG+S, um die Details zu speichern.

Die Details deiner konfigurierten MCP-Server werden in der Datei mcp-config.json gespeichert, die sich standardmäßig im Verzeichnis ~/.config befindet. Dieser Speicherort kann durch Festlegen der Umgebungsvariablen XDG_CONFIG_HOME geändert werden. Informationen zur JSON-Struktur einer Serverdefinition findest du unter Erweitern des GitHub Copilot-Programmier-Agents mit Model Context Protocol (MCP).

Weitere Informationen

Führe eine der folgenden Aktionen aus, um eine vollständige Liste der Befehlszeilenoptionen und Schrägstrichbefehle zu erhalten, die du mit Copilot-CLI verwenden kannst:

  • Gib ? in das Promptfeld einer interaktiven Sitzung ein.
  • Gib copilot help in deinem Terminal ein.

Verwende in deinem Terminal einen der folgenden Befehle, um weitere Informationen zu erhalten:

  • Konfigurationseinstellungen:

    copilot help config

    Du kannst die Konfigurationseinstellungen anpassen, indem du die Datei config.json bearbeitest, die sich standardmäßig im Verzeichnis ~/.config befindet. Dieser Speicherort kann durch Festlegen der Umgebungsvariablen XDG_CONFIG_HOME geändert werden.

  • Umgebungsvariablen, die sich auf Copilot-CLI auswirken:

    copilot help environment

  • Verfügbare Protokolliergrade:

    copilot help logging

  • Berechtigungen zum Zulassen oder Verweigern der Toolverwendung:

    copilot help permissions

Feedback

Sende dein Feedback zur GitHub Copilot-CLI an uns, indem du in einer interaktiven Sitzung den Schrägstrichbefehl /feedback verwendest und eine der Optionen auswählst. Du kannst an einer privaten Feedbackumfrage teilnehmen, einen Fehlerbericht übermitteln oder ein neues Feature vorschlagen.