Skip to main content

GitHub Copilot CLI Programmreferenz

Suchen Sie Optionen zum Ausführen von Copilot CLI programmgesteuert.

Zusätzlich zum interaktiven Ausführen von Copilot CLI können Sie auch eine Eingabeaufforderung direkt an die CLI in einem einzigen Befehl übergeben, ohne in eine interaktive Sitzung zu wechseln. Auf diese Weise können Sie Copilot programmgesteuert in Skripts, CI/CD-Pipelines und Automatisierungsworkflows verwenden. Weitere Informationen findest du unter Programmgesteuertes Ausführen von GitHub Copilot CLI.

In diesem Artikel werden Befehlszeilenoptionen und Umgebungsvariablen beschrieben, die bei der automatisierten Ausführung von Copilot CLI besonders relevant sind.

Eine vollständige Liste der verfügbaren Optionen finden Sie unter GitHub Copilot CLI-Befehlsreferenz , oder geben Sie den folgenden Befehl in Ihr Terminal ein:

Shell
copilot help

Befehlszeilenoptionen

Es gibt eine Reihe von Befehlszeilenoptionen, die besonders nützlich sind, wenn Copilot CLI programmatisch ausgeführt werden.

AuswahlBeschreibung
-p PROMPTFühren Sie eine Eingabeaufforderung im nicht interaktiven Modus aus. Die CLI führt die Eingabeaufforderung aus und beendet den Vorgang nach Abschluss.
-sUnterdrücken Sie Statistiken und Dekoration, und geben Sie nur die Antwort des Agenten aus. Ideal für die Rohrleitungsausgabe in Skripts.
--add-dir=DIRECTORYFügen Sie der Liste der zulässigen Pfade ein Verzeichnis hinzu. Dies kann mehrmals verwendet werden, um mehrere Verzeichnisse hinzuzufügen. Nützlich, wenn der Agent außerhalb des aktuellen Arbeitsverzeichnisses Lese-/Schreibzugriff benötigt.
--agent=AGENTGeben Sie eine Benutzerdefinierter Agent zur Verwendung an.
          `--allow-all` (oder `--yolo`)   | Zulassen, dass die CLI alle Berechtigungen besitzt. Entspricht `--allow-all-tools --allow-all-paths --allow-all-urls`. |

| --allow-all-paths | Deaktivieren Sie die Überprüfung des Dateipfads vollständig. Einfachere Alternative zu --add-dir, wenn keine Pfadeinschränkungen erforderlich sind. | | --allow-all-tools | Zulassen, dass jedes Tool ohne explizite Berechtigung für jedes Tool ausgeführt werden kann. | | --allow-all-urls | Zugriff auf alle URLs ohne explizite Berechtigung für jede URL zulassen. | | --allow-tool=TOOL ... | Erteilen Sie selektiv berechtigungen für ein bestimmtes Tool. Verwenden Sie für mehrere Tools eine in Anführungszeichen gesetzte, durch Kommas getrennte Liste. | | --allow-url=URL ... | Zulassen, dass der Agent eine bestimmte URL oder Domäne abruft. Nützlich, wenn ein Workflow Webzugriff auf bekannte Endpunkte benötigt. Verwenden Sie für mehrere URLs eine in Anführungszeichen gesetzte, durch Kommas getrennte Liste. | | --deny-tool=TOOL ... | Verweigern sie ein bestimmtes Tool. Nützlich zum Einschränken der Aktionen des Agents in einem gesperrten Workflow. Verwenden Sie für mehrere Tools eine in Anführungszeichen gesetzte, durch Kommas getrennte Liste. | | --model=MODEL | Wählen Sie das KI-Modell aus (z. B gpt-5.2 . oder claude-sonnet-4.6). Nützlich zum Anheften eines Modells in einen reproduzierbaren Workflow. Siehe "Auswählen eines Modells unten". | | --no-ask-user | Verhindern Sie, dass der Agent anhält, um zusätzliche Benutzereingaben einzuholen. | | --secret-env-vars=VAR ... | Eine Umgebungsvariable, deren Wert in der Ausgabe entfernt werden soll. Verwenden Sie für mehrere Variablen eine in Anführungszeichen gesetzte, kommagetrennte Liste. Wichtig, um zu verhindern, dass geheime Schlüssel in Protokollen verfügbar gemacht werden. Die Werte in den GITHUB_TOKEN Variablen und COPILOT_GITHUB_TOKEN Umgebungsvariablen sind standardmäßig redigiert. | | --share=PATH | Exportieren Sie das Sitzungstranskript nach einem nicht interaktiven Abschluss in eine Markdowndatei (Standardeinstellung ./copilot-session-<ID>.md). Nützlich für die Auditierung oder Archivierung dessen, was der Agent getan hat. Beachten Sie, dass Sitzungstranskripte möglicherweise vertrauliche Informationen enthalten. | | --share-gist | Veröffentlichen Sie das Sitzungstranskript als geheimen GitHub-Gist nach Abschluss. Praktisch für die Freigabe von Ergebnissen aus der kontinuierlichen Integration (CI). Beachten Sie, dass Sitzungstranskripte möglicherweise vertrauliche Informationen enthalten. |

Tools für die --allow-tool Option

Sie können verschiedene Arten von Tools mit der --allow-tool Option angeben.

Art des ToolsWas sie steuert
ShellAusführen von Shellbefehlen.
writeErstellen oder Ändern von Dateien
readLesen von Dateien oder Verzeichnissen.
urlAbrufen von Inhalten aus einer URL.
GedächtnisSpeichern neuer Fakten im beständigen Speicher des Agents. Dies wirkt sich nicht auf die Verwendung vorhandener Erinnerungen aus. Siehe Informationen zum agentischen Speicher für GitHub Copilot.
MCP-SERVERAufrufen von Tools von einem bestimmten MCP-Server. Verwenden Sie den konfigurierten Namen des Servers als Bezeichner, githubz. B. . Siehe Hinzufügen von MCP-Servern für GitHub Copilot CLI.

Werkzeugfilter

Mit den Tooltypen shell, write, url und dem MCP-Server-Tool können Sie einen Filter in Klammern angeben, um zu steuern, welche spezifischen Tools zulässig sind.

Art des ToolsBeispielErläuterung des Beispiels
          **Shell** | `shell(git:*)` | Alle Git-Unterbefehle zulassen (`git push`, `git status`usw.). |

| | shell(npm test) | Exakten Befehl npm test zulassen. | | schreiben | write(.github/copilot-instructions.md) | Ermöglichen Sie der CLI, in diesen spezifischen Pfad zu schreiben. | | | write(README.md) | Erlauben Sie der CLI, in jede Datei zu schreiben, deren Pfad mit /README.md endet. | | url | url(github.com) | Zulassen, dass die CLI auf HTTPS-URLs auf github.com zugreifen kann. | | | url(http://localhost:3000) | Ermöglichen Sie der CLI den Zugriff auf den lokalen Entwicklungsserver mit expliziten Protokollen und Port. | | | url(https://*.github.com) | Ermöglichen Sie der CLI den Zugriff auf GitHub Subdomäne (z. B api.github.com. ). | | | url(https://docs.github.com/copilot/*) | Zugriff auf Copilot Dokumentation auf dieser Website zulassen. | | MCP-SERVER | github(create_issue) | Nur das create_issue Tool vom github MCP-Server zulassen. |

Hinweis

Wildcards werden nur unterstützt für shell, um alle Unterbefehle eines angegebenen Tools abzugleichen, sowie für url, wenn am Anfang eines Hostnamens, um mit einer beliebigen Subdomäne zu korrespondieren, oder am Ende eines Pfads, um eine beliebige Pfadendung abzugleichen, wie in der vorherigen Tabelle gezeigt.

Umgebungsvariablen

Sie können Umgebungsvariablen verwenden, um verschiedene Aspekte des Cli-Verhaltens bei der programmgesteuerten Ausführung zu konfigurieren. Dies ist besonders nützlich für das Festlegen der Konfiguration in CI/CD-Workflows oder anderen automatisierten Umgebungen, in denen Sie bestimmte Optionen möglicherweise nicht direkt in der Befehlszeile angeben möchten.

VariableBeschreibung
COPILOT_ALLOW_ALLFür vollständige Berechtigungen festlegen auf true
COPILOT_MODELFestlegen des Modells (z. B gpt-5.2. , claude-sonnet-4.5)
COPILOT_HOMEFestlegen des Verzeichnisses für die CLI-Konfigurationsdatei (~/.copilot standardmäßig)
COPILOT_GITHUB_TOKENAuthentifizierungstoken (höchste Priorität)
GH_TOKENAuthentifizierungstoken (zweite Rangfolge)
GITHUB_TOKENAuthentifizierungstoken (dritte Rangfolge)

Um vollständige Details zu Umgebungsvariablen für Copilot CLIzu erhalten, verwenden Sie den Befehl copilot help environment in Ihrem Terminal.

Auswählen eines Modells

Wenn Sie eine Eingabeaufforderung an Copilot CLI im nicht-interaktiven Modus senden, wird das Modell, das von der CLI zum Generieren einer Antwort verwendet wird, in der Antwortausgabe angezeigt (wenn die Optionen -s oder --silent nicht verwendet werden).

Sie können die --model Option verwenden, um anzugeben, welches KI-Modell die CLI verwenden soll. Auf diese Weise können Sie ein Modell auswählen, das am besten für Ihren Prompt geeignet ist, indem es Faktoren wie Geschwindigkeit, Kosten und Fähigkeiten ausbalanciert.

Beispielsweise können Sie für einfache Aufgaben, z. B. die Erläuterung von Code oder das Generieren einer Zusammenfassung, ein schnelles, niedrigeres Kostenmodell wie ein Claude Haiku-Modell auswählen:

Bash
copilot -p "What does this project do?" -s --model claude-haiku-4.5

Für komplexere Aufgaben, die eine tiefere Begründung erfordern , z. B. Debuggen oder Umgestaltung von Code, können Sie ein leistungsfähigeres Modell auswählen, z. B. ein GPT Codex-Modell:

Bash
copilot -p "Fix the race condition in the worker pool" \
  --model gpt-5.3-codex \
  --allow-tool='write, shell'

Hinweis

Sie finden die Modellzeichenfolgen für alle verfügbaren Modelle in der Beschreibung der --model Option, wenn Sie in Ihr Terminal eingeben copilot help .

Alternativ können Sie die COPILOT_MODEL Umgebungsvariable so festlegen, dass ein Modell für die Dauer der Shellsitzung angegeben wird.

Um eine Modellauswahl über Shellsitzungen hinweg beizubehalten, können Sie den model Schlüssel in der CLI-Konfigurationsdatei festlegen. Diese Datei befindet sich unter ~/.copilot/config.json (oder $COPILOT_HOME/.copilot/config.json wenn Sie die COPILOT_HOME Umgebungsvariable festgelegt haben). Einige Modelle ermöglichen es Ihnen auch, einen Denkaufwand festzulegen, der steuert, wie viel Zeit das Modell vor dem Reagieren investiert.

JSON
{
  "model": "gpt-5.3-codex",
  "reasoning_effort": "low"
}

Tipp

Die einfachste Möglichkeit zum dauerhaften Festlegen eines Modells in der Konfigurationsdatei ist der /model Schrägstrichbefehl in einer interaktiven Sitzung. Die Auswahl, die Sie mit diesem Befehl treffen, wird in die Konfigurationsdatei geschrieben.

Modellrangfolge

Bei der Bestimmung, welches Modell für eine bestimmte Eingabeaufforderung verwendet werden soll, sucht die CLI nach Modellspezifikationen in der folgenden Reihenfolge der Rangfolge (von der höchsten zur niedrigsten):

  • Dabei wird ein benutzerdefinierter Agent verwendet: das in der definition des benutzerdefinierten Agents angegebene Modell (falls vorhanden).
  • Die --model Befehlszeilenoption.
  • Die COPILOT_MODEL Umgebungsvariable.
  • Der model Schlüssel in der Konfigurationsdatei (~/.copilot/config.json oder $COPILOT_HOME/.copilot/config.json).
  • Das Standardmodell der CLI.

Verwenden von benutzerdefinierten Agenten

Sie können Die Arbeit an einen spezialisierten Agent delegieren, indem Sie die --agent Option verwenden. Weitere Informationen findest du unter Erstellen und verwenden von kundenspezifischen Agenten für GitHub Copilot CLI.

In diesem Beispiel wird der code-review Agent verwendet. Dies erfordert, dass ein benutzerdefinierter Agent mit diesem Namen erstellt wurde.

copilot -p "Review the latest commit" \
  --allow-tool='shell' \
  --agent code-review

Weiterführende Lektüre

  •         [AUTOTITLE](/copilot/how-tos/copilot-cli)
    
  •         [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference)
    
  •         [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-plugin-reference)