Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Amazon Q CLI-Befehlsreferenz
Dieser Abschnitt enthält eine vollständige Referenz für alle Befehle der Amazon Q Developer CLI und ihre Argumente. Verwenden Sie diese Referenz, um die verfügbaren Optionen für jeden Befehl und ihre korrekte Syntax zu verstehen.
Wenn Sie Hilfe zu einem Befehl benötigen, können Sie das Flag --help verwenden:
q [COMMAND] --help
Globale Argumente
Die folgenden Argumente sind mit jedem Befehl der Amazon Q CLI verfügbar:
| Argument | Kurzform | Description |
|---|---|---|
--verbose
|
-v
|
Die Ausführlichkeit der Protokollierung erhöhen. Kann für eine ausführlichere Ausgabe wiederholt werden: -v, -vv, -vvv, -vvvv |
--help
|
-h
|
Hilfeinformationen für den Befehl anzeigen |
--version
|
-V
|
Versionsinformationen anzeigen |
--help-all
|
Die Hilfe für alle Unterbefehle drucken |
Befehle
In den folgenden Abschnitten werden die einzelnen Befehle der Amazon Q CLI und ihre verfügbaren Argumente beschrieben.
q chat
Starten Sie eine interaktive Chat-Sitzung mit Amazon Q. Wenn kein Unterbefehl angegeben wurde, nimmt q den Standardwert q chat an.
Syntax:
q chat [OPTIONS] [INPUT]
| Argument | Kurzform | Description |
|---|---|---|
--no-interactive
|
Die erste Antwort auf STDOUT ohne interaktiven Modus drucken. Dies schlägt fehl, wenn im Prompt Berechtigungen zur Verwendung eines Tools angefordert werden, es sei denn, --trust-all-tools wird auch verwendet. |
|
--resume
|
-r
|
Die vorherige Konversation von diesem Verzeichnis aus fortsetzen |
--agent
|
Zu verwendender Agent | |
--trust-all-tools
|
Dem Modell erlauben, ein beliebiges Tool zum Ausführen von Befehlen zu verwenden, ohne nach einer Bestätigung zu fragen | |
--trust-tools
|
Nur den angegebenen Tools vertrauen. Stellen Sie eine durch Komma getrennte Liste der Toolnamen bereit. Beispiel: --trust-tools=fs_read,fs_write. Wenn Sie keinem Tool vertrauen, verwenden Sie --trust-tools=. |
|
INPUT
|
Die erste Frage, die gestellt werden muss (Positionsargument) |
Beispiele:
q chat q chat "How do I list files in Linux?" q chat --no-interactive --trust-all-tools "Show me the current directory" q chat --resume q chat --agent my-agent "Help me with AWS CLI"
q translate
Übersetzen Sie Anweisungen in natürlicher Sprache mithilfe von KI in ausführbare Shell-Befehle.
Syntax:
q translate [OPTIONS] [INPUT...]
| Argument | Kurzform | Description |
|---|---|---|
--n
|
-n
|
Anzahl der zu generierenden Vervollständigungen (muss ≤ 5 sein) |
INPUT
|
Beschreibung des Befehls, den Sie generieren möchten, in natürlicher Sprache (Positionsargumente) |
Beispiele:
q translate "list all files in the current directory" q translate "find all Python files modified in the last week" q translate "compress all log files older than 30 days"
q doctor
Beheben und diagnostizieren Sie häufig auftretende Installations- und Konfigurationsprobleme mit Amazon Q.
Syntax:
q doctor [OPTIONS]
| Argument | Kurzform | Description |
|---|---|---|
--all
|
-a
|
Alle Diagnosetests durchführen, ohne Korrekturen |
--strict
|
-s
|
Fehler bei Warnungen |
Beispiele:
q doctor q doctor --all q doctor --strict
q update
Aktualisieren Sie die Amazon-Q-Anwendung auf die neueste Version.
Syntax:
q update [OPTIONS]
| Argument | Kurzform | Description |
|---|---|---|
--non-interactive
|
-y
|
Nicht zur Bestätigung auffordern |
--relaunch-dashboard
|
Das Dashboard nach dem Update erneut starten. Der Standardwert ist „true“. | |
--rollout
|
Rollout verwenden |
Beispiele:
q update q update --non-interactive q update --rollout
q theme
Rufen Sie das visuelle Design für das Dropdown-Menü zur automatischen Vervollständigung ab oder legt Sie es fest. Dies wirkt sich auf das Erscheinungsbild des Popup-Fensters aus, in dem die Ausführung von Befehlen angezeigt wird.
Syntax:
q theme [OPTIONS] [THEME]
| Argument | Description |
|---|---|
--list
|
Alle verfügbaren Designs auflisten |
--folder
|
Den Pfad zum Designverzeichnis anzeigen |
THEME
|
Der Name des Designs, das festgelegt werden soll. Zu den integrierten Designs gehören: dark, light, system (Positionsargument) |
Beispiele:
q theme --list q theme --folder q theme dark q theme light q theme system
Hinweis: Designänderungen wirken sich auf das Popup-Fenster zur automatischen Vervollständigung aus. Möglicherweise müssen Sie Vorschläge zur automatischen Vervollständigung auslösen, um die visuellen Änderungen zu sehen.
q integrations
Verwalten Sie Systemintegrationen für Amazon Q.
Syntax:
q integrations [SUBCOMMAND] [OPTIONS]
q integrations subcommands
| Unterbefehl | Description |
|---|---|
install
|
Eine Integration installieren. Unterstützt --silent (-s) zur Unterdrückung von Statusmeldungen |
uninstall
|
Eine Integration deinstallieren. Unterstützt --silent (-s) zur Unterdrückung von Statusmeldungen |
reinstall
|
Eine Integration erneut installieren. Unterstützt --silent (-s) zur Unterdrückung von Statusmeldungen |
status
|
Den Status einer Integration überprüfen. Unterstützt --format (-f) für das Ausgabeformat |
q inline
Verwalten Sie Inline-Vorschläge, die während der Eingabe (als „Geistertext“) direkt in Ihrer Befehlszeile angezeigt werden. Weitere Informationen finden Sie unter Funktionen für die Befehlszeilenunterstützung.
Syntax:
q inline [SUBCOMMAND] [OPTIONS]
q inline subcommands
| Unterbefehl | Description |
|---|---|
enable
|
Inline-Vorschläge aktivieren, die während der Eingabe angezeigt werden |
disable
|
Inline-Vorschläge deaktivieren |
status
|
Anzeigen, ob Inline-Vorschläge aktiviert oder deaktiviert sind |
set-customization
|
Ein zu verwendendes Anpassungsmodell auswählen. Optional den ARN der Anpassung angeben |
show-customizations
|
Verfügbare Anpassungsmodelle anzeigen. Unterstützt --format (-f) für das Ausgabeformat |
Beispiele:
q inline enable q inline disable q inline status q inline set-customization q inline set-customization arn:aws:codewhisperer:us-east-1:123456789012:customization/example q inline show-customizations q inline show-customizations --format json
q login
Authentifizieren Sie sich bei Amazon Q mit AWS Builder ID (kostenlos) oder IAM Identity Center (Pro).
Syntax:
q login [OPTIONS]
| Argument | Description |
|---|---|
--license
|
Art der Lizenz; Optionen: free (für Builder-ID), pro (für Identity Center) |
--identity-provider
|
URL des Identitätsanbieters (für Identity Center) |
--region
|
AWS-Region (für Identity Center) |
--use-device-flow
|
Verwenden Sie immer den OAuth Gerätefluss für die Authentifizierung. Nützlich, wenn Browser-Weiterleitungen nicht verarbeitet werden können |
Beispiele:
q login q login --license free q login --license pro --identity-provider https://my-company.awsapps.com/start --region us-east-1 q login --use-device-flow
q logout
Melden Sie sich von Ihrer Amazon-Q-Sitzung ab.
Syntax:
q logout
Dieser Befehl benötigt keine zusätzlichen Argumente.
q whoami
Informationen zum aktuellen Benutzer- und Authentifizierungsstatus anzeigen
Syntax:
q whoami [OPTIONS]
| Argument | Kurzform | Description |
|---|---|---|
--format
|
-f
|
Ausgabeformat; Optionen: plain (Standard), json, json-pretty |
q profile
Zeigen Sie das Profil an, das dem aktuellen Benutzer von IAM Identity Center zugeordnet ist. Dieser Befehl ist nur für Pro-Benutzer verfügbar.
Syntax:
q profile
Dieser Befehl benötigt keine zusätzlichen Argumente.
q settings
Die Amazon-Q-Konfigurationseinstellungen verwalten. Ausführliche Informationen zur Verwaltung der Einstellungen finden Sie unter Amazon Q-Einstellungen konfigurieren.
Syntax:
q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
| Argument | Kurzform | Description |
|---|---|---|
--delete
|
-d
|
Eine Einstellung löschen |
--format
|
-f
|
Ausgabeformat; Optionen: plain (Standard), json, json-pretty |
KEY
|
Schlüssel festlegen (Positionsargument) | |
VALUE
|
Wert festlegen (Positionsargument) |
q settings subcommands
| Unterbefehl | Description |
|---|---|
open
|
Die Einstellungsdatei in Ihrem Standardeditor öffnen |
list
|
Listet die konfigurierten Einstellungen auf. Wird verwendet--all, um alle verfügbaren Einstellungen mit Beschreibungen anzuzeigen. Unterstützt die Option --format |
all
|
(Veraltet) Listet alle aktuellen Einstellungen auf. Verwenden Sie stattdessen list. Unterstützt die Option --format |
/fordert auf
Verwalte wiederverwendbare Vorlagen für Eingabeaufforderungen für Chat-Interaktionen. Umfassende Informationen zur Verwaltung von Eingabeaufforderungen und Argumenten finden Sie unterEingabeaufforderungen verwalten.
Syntax:
/prompts [SUBCOMMAND] [OPTIONS] [NAME] [ARGUMENTS...]
| Argument | Description |
|---|---|
NAME |
Name der Eingabeaufforderung (für weitere Informationen, Befehle zum Erstellen, Bearbeiten und Entfernen) |
ARGUMENTS... |
Argumente, die bei Verwendung des get Befehls an die Eingabeaufforderung übergeben werden sollen |
/fordert Unterbefehle auf
| Unterbefehl | Description |
|---|---|
list [search-word] |
Listet verfügbare Eingabeaufforderungen auf, optional nach Suchwort gefiltert |
details <name> |
Zeigt detaillierte Informationen zu einer Aufforderung an, einschließlich Argumenten, Verwendung und Beispielen |
get <name> [args...] |
Ruft eine Eingabeaufforderung mit optionalen Argumenten ab und führt sie aus |
create --name <name> [--content text] [--global] |
Erstellen Sie eine neue Eingabeaufforderung. Öffnet den Editor, wenn kein Inhalt bereitgestellt wird |
edit <name> [--global] |
Bearbeiten Sie eine bestehende Eingabeaufforderung in Ihrem Standardeditor |
remove <name> [--global] |
Eine bestehende Aufforderung entfernen (Bestätigung erforderlich) |
Verwenden von Eingabeaufforderungen im Chat
Eingabeaufforderungen können direkt im Chat mit dem Präfix @ aufgerufen werden:
@<prompt-name> [arguments...]
Beispiele:
# Simple prompt without arguments @code-review # Prompt with single argument @debug-help "connection timeout error" # Prompt with multiple arguments @aws-deploy "my-service" "production" "us-west-2" # Server-specific prompt (when ambiguous) @dev-tools/analyze "performance issue"
Argumente auffordern
Eingabeaufforderungen können Argumente akzeptieren, um ihr Verhalten anzupassen:
Erforderliche Argumente: Müssen angegeben werden, angezeigt als
<arg>Optionale Argumente: Können weggelassen werden, angezeigt als
[arg]Argumente in Anführungszeichen: Verwenden Sie Anführungszeichen für Argumente, die Leerzeichen enthalten
Wird verwendet/prompts details <name>, um herauszufinden, welche Argumente eine Eingabeaufforderung akzeptiert.
q diagnostic
Führen Sie Diagnosetests durch, um Probleme mit der Installation und Konfiguration von Amazon Q zu beheben.
Syntax:
q diagnostic [OPTIONS]
| Argument | Kurzform | Description |
|---|---|---|
--format
|
-f
|
Ausgabeformat; Optionen: plain (Standard), json, json-pretty |
--force
|
Eingeschränkte Diagnoseausgabe erzwingen |
q issue
Erstellen Sie eine neue GitHub Ausgabe für Amazon Q-Feedback oder Fehlerberichte.
Syntax:
q issue [OPTIONS] [DESCRIPTION...]
| Argument | Kurzform | Description |
|---|---|---|
--force
|
-f
|
Erstellen von Problemen erzwingen |
DESCRIPTION
|
Beschreibung des Problems (Positionsargumente) |
q version
Blenden Sie Versionsinformationen ein und zeigen Sie optional das Änderungsprotokoll an.
Syntax:
q version [OPTIONS]
| Argument | Description |
|---|---|
--changelog[=VERSION]
|
Das Changelog anzeigen. Verwenden Sie --changelog für die aktuelle Version, --changelog=all für alle Versionen oder --changelog=x.x.x für eine bestimmte Version. |
q mcp
Model Context Protocol (MCP)-Server verwalten. Ausführliche Informationen zu MCP finden Sie unter Verwenden von MCP mit Amazon Q Developer.
Syntax:
q mcp [SUBCOMMAND] [OPTIONS]
q mcp add
Fügen Sie einen konfigurierten MCP-Server hinzu oder ersetzen Sie ihn.
Syntax:
q mcp add [OPTIONS]
| Argument | Description |
|---|---|
--name
|
Name des Servers (erforderlich) |
--command
|
Der Befehl, der zum Starten des Servers verwendet wurde (erforderlich) |
--scope
|
Wo der Server hinzugefügt werden soll. Optionen:workspace, global |
--env
|
Umgebungsvariablen, die beim Starten des Servers verwendet werden sollen. Format: key1=value1,key2=value2 |
--timeout
|
Timeout beim Serverstart in Millisekunden |
--force
|
Einen vorhandenen Server mit demselben Namen überschreiben |
q mcp remove
Entfernen Sie einen Server aus der MCP-Konfiguration.
Syntax:
q mcp remove [OPTIONS]
| Argument | Description |
|---|---|
--name
|
Name des Servers, der entfernt werden soll (erforderlich) |
--scope
|
Bereich, aus dem er entfernt werden soll. Optionen:workspace, global |
q mcp list
Listen Sie konfigurierte MCP-Server auf.
Syntax:
q mcp list [SCOPE]
| Argument | Description |
|---|---|
SCOPE
|
Umfang der Liste. Optionen: workspace, global (Positionsargument) |
q mcp import
Importieren Sie eine Serverkonfiguration aus einer anderen Datei.
Syntax:
q mcp import [OPTIONS] [SCOPE]
| Argument | Description |
|---|---|
--file
|
Datei, aus der die Serverkonfiguration importiert werden soll (erforderlich) |
--force
|
Einen vorhandenen Server mit demselben Namen überschreiben |
SCOPE
|
Bereich, in den importiert werden soll. Optionen: workspace, global (Positionsargument) |
q mcp status
Rufen Sie den Status eines konfigurierten MCP-Servers ab.
Syntax:
q mcp status [OPTIONS]
| Argument | Description |
|---|---|
--name
|
Name des Servers, für den der Status abgerufen werden soll (erforderlich) |
Protokolldateien
Die Amazon Q Developer CLI verwaltet Protokolldateien, die für die Fehlerbehebung nützlich sein können. Diese Protokolle werden nur auf Ihrem lokalen Computer gespeichert und nicht an AWS gesendet.
Speicherorte der Protokolldateien:
-
macOS:
$TMPDIR/qlog/ -
Linux:
$XDG_RUNTIME_DIR,TMPDIRoder/tmp
Die Protokollebene kann durch Festlegen der Umgebungsvariable Q_LOG_LEVEL gesteuert werden. Gültige Werte sind:
-
error: nur Fehlermeldungen (Standard) -
warn: Warn- und Fehlermeldungen -
info: Informations-, Warn- und Fehlermeldungen -
debug: Debug-, Informations-, Warn- und Fehlermeldungen -
trace: alle Meldungen, einschließlich detaillierter Ablaufverfolgungsinformationen
Warnung
Protokolldateien können vertrauliche Informationen aus Ihren Konversationen und Interaktionen mit Amazon Q enthalten, darunter Dateipfade, Codeausschnitte und Befehlsausgaben. Obwohl diese Protokolle nur auf Ihrem lokalen Computer gespeichert und nicht an AWS gesendet werden, sollten Sie vorsichtig sein, wenn Sie Protokolldateien mit anderen teilen.
Beispiel für die Festlegung der Protokollebene (zu Debugging-Zwecken):
# For bash/zsh export Q_LOG_LEVEL=debug q chat # For fish set -x Q_LOG_LEVEL debug q chat
