Amazon Q CLI-Befehlsreferenz - Amazon Q Developer
Globale ArgumenteBefehleProtokolldateien

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 umfassende Referenz für alle Amazon Q Developer CLI-Befehle 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 jedem Befehl benötigen, können Sie das --help Flag verwenden:

q [COMMAND] --help

Globale Argumente

Die folgenden Argumente sind mit jedem Amazon Q CLI-Befehl verfügbar:

Globale Argumente
Argument Kurzform Beschreibung
--verbose -v Erhöhen Sie die Ausführlichkeit der Protokollierung. Kann für eine ausführlichere Ausgabe wiederholt werden:-v,,, -vv -vvv -vvvv
--help -h Zeigt Hilfeinformationen für den Befehl an
--version -V Versionsinformationen anzeigen
--help-all Druckt die Hilfe für alle Unterbefehle

Befehle

In den folgenden Abschnitten werden die einzelnen Amazon Q CLI-Befehle und ihre verfügbaren Argumente beschrieben.

ein Chat

Starten Sie eine interaktive Chat-Sitzung mit Amazon Q. Wenn kein Unterbefehl angegeben ist, ist der q Standardwert. q chat

Syntax: 

q chat [OPTIONS] [INPUT]
q Chat-Argumente
Argument Kurzform Beschreibung
--no-interactive Druckt die erste Antwort auf STDOUT ohne interaktiven Modus. Dies schlägt fehl, wenn in der Aufforderung Berechtigungen zur Verwendung eines Tools angefordert werden, es sei denn, es --trust-all-tools wird auch verwendet
--resume -r Setzt die vorherige Konversation von diesem Verzeichnis aus fort
--profile Zu verwendendes Kontextprofil
--trust-all-tools Erlauben Sie dem Modell, ein beliebiges Tool zum Ausführen von Befehlen zu verwenden, ohne nach einer Bestätigung zu fragen
--trust-tools Vertrauen Sie nur den angegebenen Tools. Geben Sie eine durch Kommas getrennte Liste von Werkzeugnamen an. Beispiel: --trust-tools=fs_read,fs_write. Um keinem Tool zu 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 --profile my-profile "Help me with AWS CLI"

q übersetze

Translate Sie Anweisungen in natürlicher Sprache mithilfe von KI in ausführbare Shell-Befehle.

Syntax: 

q translate [OPTIONS] [INPUT...]
q) Argumente übersetzen
Argument Kurzform Beschreibung
--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"

ein Arzt

Beheben und diagnostizieren Sie häufig auftretende Installations- und Konfigurationsprobleme mit Amazon Q.

Syntax: 

q doctor [OPTIONS]
Argumente eines Arztes
Argument Kurzform Beschreibung
--all -a Führen Sie alle ärztlichen Tests durch, ohne Korrekturen
--strict -s Fehler bei Warnungen

Beispiele: 

q doctor
q doctor --all
q doctor --strict

ein Update

Aktualisieren Sie die Amazon Q-Anwendung auf die neueste Version.

Syntax: 

q update [OPTIONS]
q) Argumente aktualisieren
Argument Kurzform Beschreibung
--non-interactive -y Fordere nicht zur Bestätigung auf
--relaunch-dashboard Starten Sie das Dashboard nach dem Update erneut. Die Standardeinstellung ist wahr
--rollout Verwendet Rollout

Beispiele: 

q update
q update --non-interactive
q update --rollout

ein Thema

Ruft das visuelle Design für das Drop-down-Menü zur automatischen Vervollständigung ab oder legt 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]
Argumente für ein q-Thema
Argument Beschreibung
--list Listet alle verfügbaren Themen auf
--folder Zeigt den Pfad des Theme-Verzeichnisses an
THEME Name des Themas, das festgelegt werden soll. Zu den integrierten Themen gehören: darklight,, system (Positionsargument)

Beispiele: 

q theme --list
q theme --folder
q theme dark
q theme light
q theme system

Hinweis: Theme-Änderungen wirken sich auf das Popup-Fenster mit der automatischen Vervollständigung aus. Möglicherweise müssen Sie Vorschläge zur automatischen Vervollständigung auslösen, um die visuellen Änderungen zu sehen.

q-Integrationen

Systemintegrationen für Amazon Q verwalten

Syntax: 

q integrations [SUBCOMMAND] [OPTIONS]

Unterbefehle für q-Integrationen

Unterbefehle für q-Integrationen
Unterbefehl Beschreibung
install Installieren Sie eine Integration. Unterstützt --silent (-s) zur Unterdrückung von Statusmeldungen
uninstall Deinstallieren Sie eine Integration. Unterstützt --silent (-s) zur Unterdrückung von Statusmeldungen
reinstall Installieren Sie eine Integration erneut. Unterstützt --silent (-s) zur Unterdrückung von Statusmeldungen
status Überprüfen Sie den Status einer Integration. Unterstützt --format (-f) für das Ausgabeformat

q ist online

Verwaltet Inline-Vorschläge (Ghost-Text), die während der Eingabe direkt in der Befehlszeile angezeigt werden. Weitere Informationen finden Sie unter Funktionen zur Befehlszeilenunterstützung.

Syntax: 

q inline [SUBCOMMAND] [OPTIONS]

q Inline-Unterbefehle

q Inline-Unterbefehle
Unterbefehl Beschreibung
enable Aktivieren Sie Inline-Vorschläge, die während der Eingabe angezeigt werden
disable Deaktivieren Sie Inline-Vorschläge
status Zeigt an, ob Inline-Vorschläge aktiviert oder deaktiviert sind
set-customization Wählen Sie ein zu verwendendes Anpassungsmodell aus. Geben Sie optional den ARN der Anpassung an
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 einloggen

Authentifizieren Sie sich bei Amazon Q mit AWS Builder ID (kostenlos) oder IAM Identity Center (Pro).

Syntax: 

q login [OPTIONS]
q Anmeldeargumente
Argument Beschreibung
--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 Abmeldung

Melden Sie sich von Ihrer Amazon Q-Sitzung ab.

Syntax: 

q logout

Dieser Befehl benötigt keine zusätzlichen Argumente.

ein Whoami

Zeigt Informationen zum aktuellen Benutzer- und Authentifizierungsstatus an.

Syntax: 

q whoami [OPTIONS]
q Whoami-Argumente
Argument Kurzform Beschreibung
--format -f Ausgabeformat. Optionen: plain (Standard)json, json-pretty

ein Profil

Zeigt das Profil an, das dem aktuellen IAM Identity Center-Benutzer zugeordnet ist. Dieser Befehl ist nur für Pro-Benutzer verfügbar.

Syntax: 

q profile

Dieser Befehl benötigt keine zusätzlichen Argumente.

q Einstellungen

Verwalten Sie die Amazon Q-Konfigurationseinstellungen. Ausführliche Informationen zur Verwaltung der Einstellungen finden Sie unterKonfiguration der Amazon Q-Einstellungen.

Syntax: 

q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
q Einstellungsargumente
Argument Kurzform Beschreibung
--delete -d Lösche eine Einstellung
--format -f Ausgabeformat. Optionen: plain (Standard)json, json-pretty
KEY Einstellschlüssel (Positionsargument)
VALUE Wert setzen (Positionsargument)

q, Unterbefehle für Einstellungen

q Unterbefehle für Einstellungen
Unterbefehl Beschreibung
open Öffnen Sie die Einstellungsdatei in Ihrem Standardeditor
all Listet alle aktuellen Einstellungen auf. Unterstützt die --format Option

eine Diagnose

Führen Sie Diagnosetests durch, um Probleme mit der Installation und Konfiguration von Amazon Q zu beheben.

Syntax: 

q diagnostic [OPTIONS]
q Diagnoseargumente
Argument Kurzform Beschreibung
--format -f Ausgabeformat. Optionen: plain (Standard)json, json-pretty
--force Eingeschränkte Diagnoseausgabe erzwingen

ein Problem

Erstellen Sie eine neue GitHub Ausgabe für Amazon Q-Feedback oder Fehlerberichte.

Syntax: 

q issue [OPTIONS] [DESCRIPTION...]
Argumente für ein Problem
Argument Kurzform Beschreibung
--force -f Erzwingen Sie die Entstehung von Problemen
DESCRIPTION Beschreibung des Problems (Positionsargumente)

eine Version

Zeigt Versionsinformationen an und zeigt optional das Changelog an.

Syntax: 

q version [OPTIONS]
q Versionsargumente
Argument Beschreibung
--changelog[=VERSION] Zeigt das Changelog an. Verwenden Sie es --changelog für die aktuelle Version, --changelog=all für alle Versionen oder --changelog=x.x.x für eine bestimmte Version

ein MCP

Verwalten Sie MCP-Server (Model Context Protocol). Ausführliche Informationen zu MCP finden Sie unter. Verwenden von MCP mit Amazon Q Developer

Syntax: 

q mcp [SUBCOMMAND] [OPTIONS]

q mcp hinzufügen

Fügen Sie einen konfigurierten MCP-Server hinzu oder ersetzen Sie ihn.

Syntax: 

q mcp add [OPTIONS]
q mcp fügt Argumente hinzu
Argument Beschreibung
--name Name für den Server (erforderlich)
--command Der Befehl, der zum Starten des Servers verwendet wurde (erforderlich)
--scope Wo soll der Server hinzugefügt werden? 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 Überschreiben Sie einen vorhandenen Server mit demselben Namen

q mcp entfernen

Entfernen Sie einen Server aus der MCP-Konfiguration.

Syntax: 

q mcp remove [OPTIONS]
q mcp entfernt Argumente
Argument Beschreibung
--name Name des Servers, der entfernt werden soll (erforderlich)
--scope Bereich, von dem entfernt werden soll. Optionen:workspace, global

eine MCP-Liste

Listet die konfigurierten MCP-Server auf.

Syntax: 

q mcp list [SCOPE]
q mcp listet Argumente auf
Argument Beschreibung
SCOPE Umfang der Liste. Optionen:workspace, global (Positionsargument)

ein MCP-Import

Importiert eine Serverkonfiguration aus einer anderen Datei.

Syntax: 

q mcp import [OPTIONS] [SCOPE]
q mcp-Importargumente
Argument Beschreibung
--file Datei, aus der die Serverkonfiguration importiert werden soll (erforderlich)
--force Überschreiben Sie einen vorhandenen Server mit demselben Namen
SCOPE Bereich, in den importiert werden soll. Optionen:workspace, global (Positionsargument)

ein MCP-Status

Ruft den Status eines konfigurierten MCP-Servers ab.

Syntax: 

q mcp status [OPTIONS]
q MCP-Statusargumente
Argument Beschreibung
--name Name des Servers, für den der Status abgerufen werden soll (erforderlich)

Protokolldateien

Amazon Q Developer CLI verwaltet Protokolldateien, die für die Fehlerbehebung nützlich sein können. Diese Protokolle werden lokal auf Ihrem Computer gespeichert und nicht an AWS gesendet.

Speicherorte der Protokolldateien:

  • macOS: $TMPDIR/qlog/

  • Linux: $XDG_RUNTIME_DIR oder TMPDIR oder /tmp

Die Protokollebene kann durch Setzen der Q_LOG_LEVEL Umgebungsvariablen gesteuert werden. Gültige Werte für 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 Trace-Informationen

Warnung

Protokolldateien können vertrauliche Informationen aus Ihren Konversationen und Interaktionen mit Amazon Q enthalten, darunter Dateipfade, Codefragmente 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 Einstellung 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