Référence de commande Amazon Q CLI - Amazon Q Developer
Arguments globauxCommandesLes fichiers journaux

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Référence de commande Amazon Q CLI

Cette section fournit une référence complète pour toutes les commandes de la CLI Amazon Q Developer et leurs arguments. Utilisez cette référence pour comprendre les options disponibles pour chaque commande et leur syntaxe appropriée.

Pour obtenir de l'aide avec n'importe quelle commande, vous pouvez utiliser le --help drapeau :

q [COMMAND] --help

Arguments globaux

Les arguments suivants sont disponibles avec n'importe quelle commande de la CLI Amazon Q :

Arguments globaux
Argument Formulaire abrégé Description
--verbose -v Augmentez la verbosité de la journalisation. Peut être répété pour une sortie plus détaillée :-v,,, -vv -vvv -vvvv
--help -h Afficher les informations d'aide relatives à la commande
--version -V Afficher les informations de version
--help-all Aide à l'impression pour toutes les sous-commandes

Commandes

Les sections suivantes décrivent chaque commande Amazon Q CLI et ses arguments disponibles.

un chat

Démarrez une session de discussion interactive avec Amazon Q. Lorsqu'aucune sous-commande n'est spécifiée, la q valeur par défaut est. q chat

Syntaxe : 

q chat [OPTIONS] [INPUT]
arguments du chat q
Argument Formulaire abrégé Description
--no-interactive Imprime la première réponse à STDOUT sans mode interactif. Cela échouera si l'invite demande l'autorisation d'utiliser un outil, sauf si celui-ci --trust-all-tools est également utilisé
--resume -r Reprendre la conversation précédente depuis ce répertoire
--profile Profil de contexte à utiliser
--trust-all-tools Autoriser le modèle à utiliser n'importe quel outil pour exécuter des commandes sans demander de confirmation
--trust-tools Ne faites confiance qu'à l'ensemble d'outils spécifié. Fournissez une liste de noms d'outils séparés par des virgules. Exemple: --trust-tools=fs_read,fs_write. Pour ne faire confiance à aucun outil, utilisez --trust-tools=
INPUT La première question à poser (argument positionnel)

Exemples : 

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 traduire

Translate les instructions en langage naturel en commandes shell exécutables à l'aide de l'IA.

Syntaxe : 

q translate [OPTIONS] [INPUT...]
q translate arguments
Argument Formulaire abrégé Description
--n -n Nombre de complétions à générer (doit être ≤ 5)
INPUT Description en langage naturel de la commande que vous souhaitez générer (arguments positionnels)

Exemples : 

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"

un médecin

Corrigez et diagnostiquez les problèmes courants d'installation et de configuration avec Amazon Q.

Syntaxe : 

q doctor [OPTIONS]
arguments d'un médecin
Argument Formulaire abrégé Description
--all -a Exécutez tous les tests médicaux, sans aucune solution
--strict -s Erreur sur les avertissements

Exemples : 

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

une mise à jour

Mettez à jour l'application Amazon Q vers la dernière version.

Syntaxe : 

q update [OPTIONS]
arguments de mise à jour q
Argument Formulaire abrégé Description
--non-interactive -y Ne pas demander de confirmation
--relaunch-dashboard Redémarrez dans le tableau de bord après la mise à jour. La valeur par défaut est vraie
--rollout Utilise le déploiement

Exemples : 

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

un thème

Obtenez ou définissez le thème visuel du menu déroulant de saisie semi-automatique. Cela affecte l'apparence de la fenêtre contextuelle qui indique les commandes terminées.

Syntaxe : 

q theme [OPTIONS] [THEME]
arguments du thème q
Argument Description
--list Liste de tous les thèmes disponibles
--folder Afficher le chemin du répertoire du thème
THEME Nom du thème à définir. Les thèmes intégrés incluent :dark,light, system (argument positionnel)

Exemples : 

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

Remarque : les modifications de thème ont une incidence sur la fenêtre contextuelle de saisie automatique. Vous devrez peut-être déclencher des suggestions de saisie automatique pour voir les modifications visuelles.

intégrations q

Gérez les intégrations de systèmes pour Amazon Q.

Syntaxe : 

q integrations [SUBCOMMAND] [OPTIONS]

sous-commandes d'intégration q

sous-commandes d'intégration q
Sous-commande Description
install Installez une intégration. Supporte --silent (-s) pour supprimer les messages d'état
uninstall Désinstallez une intégration. Supporte --silent (-s) pour supprimer les messages d'état
reinstall Réinstallez une intégration. Supporte --silent (-s) pour supprimer les messages d'état
status Vérifiez le statut d'une intégration. Supporte --format (-f) pour le format de sortie

q en ligne

Gérez les suggestions intégrées (texte fantôme) qui apparaissent directement sur votre ligne de commande au fur et à mesure que vous tapez. Pour de plus amples informations, consultez Fonctionnalités d'assistance en ligne de commande.

Syntaxe : 

q inline [SUBCOMMAND] [OPTIONS]

q sous-commandes en ligne

q sous-commandes en ligne
Sous-commande Description
enable Activez les suggestions intégrées qui apparaissent au fur et à mesure que vous tapez
disable Désactiver les suggestions intégrées
status Afficher si les suggestions intégrées sont activées ou désactivées
set-customization Sélectionnez le modèle de personnalisation à utiliser. Spécifiez éventuellement l'ARN de la personnalisation
show-customizations Afficher les modèles de personnalisation disponibles. Supporte --format (-f) pour le format de sortie

Exemples : 

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

connexion q

Authentifiez-vous auprès d'Amazon Q à l'aide de AWS Builder ID (gratuit) ou d'IAM Identity Center (Pro).

Syntaxe : 

q login [OPTIONS]
arguments de connexion q
Argument Description
--license Type de licence. Options : free (pour Builder ID), pro (pour Identity Center)
--identity-provider URL du fournisseur d'identité (pour Identity Center)
--region Région AWS (pour Identity Center)
--use-device-flow Utilisez toujours le flux de l' OAuth appareil pour l'authentification. Utile lorsque les redirections du navigateur ne peuvent pas être gérées

Exemples : 

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

une déconnexion

Déconnectez-vous de votre session Amazon Q.

Syntaxe : 

q logout

Cette commande ne prend aucun argument supplémentaire.

un whoami

Afficher les informations relatives à l'utilisateur actuel et à l'état de l'authentification.

Syntaxe : 

q whoami [OPTIONS]
arguments en faveur du whoami
Argument Formulaire abrégé Description
--format -f Format de sortie. Options : plain (par défaut)json, json-pretty

profil q

Afficher le profil associé à l'utilisateur actuel de l'IAM Identity Center. Cette commande n'est disponible que pour les utilisateurs Pro.

Syntaxe : 

q profile

Cette commande ne prend aucun argument supplémentaire.

paramètres q

Gérez les paramètres de configuration d'Amazon Q. Pour obtenir des informations détaillées sur la gestion des paramètres, consultezConfiguration des paramètres Amazon Q.

Syntaxe : 

q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
arguments de configuration q
Argument Formulaire abrégé Description
--delete -d Supprimer un paramètre
--format -f Format de sortie. Options : plain (par défaut)json, json-pretty
KEY Clé de réglage (argument positionnel)
VALUE Valeur de réglage (argument positionnel)

sous-commandes q settings

sous-commandes q settings
Sous-commande Description
open Ouvrez le fichier de paramètres dans votre éditeur par défaut
all Répertoriez tous les paramètres actuels. --formatOption de support

un diagnostic

Exécutez des tests de diagnostic pour résoudre les problèmes d'installation et de configuration d'Amazon Q.

Syntaxe : 

q diagnostic [OPTIONS]
arguments diagnostiques q
Argument Formulaire abrégé Description
--format -f Format de sortie. Options : plain (par défaut)json, json-pretty
--force Sortie de diagnostic à force limitée

un problème

Créez un nouveau GitHub problème pour recevoir des commentaires ou des rapports de bogues sur Amazon Q.

Syntaxe : 

q issue [OPTIONS] [DESCRIPTION...]
arguments relatifs au problème q
Argument Formulaire abrégé Description
--force -f Forcer la création d'un problème
DESCRIPTION Description du problème (arguments positionnels)

une version

Afficher les informations de version et éventuellement afficher le journal des modifications.

Syntaxe : 

q version [OPTIONS]
arguments de version q
Argument Description
--changelog[=VERSION] Afficher le journal des modifications. --changelogÀ utiliser pour la version actuelle, --changelog=all pour toutes les versions ou --changelog=x.x.x pour une version spécifique

un mcp

Gérez les serveurs MCP (Model Context Protocol). Pour des informations détaillées sur le MCP, consultezUtilisation de MCP avec Amazon Q Developer.

Syntaxe : 

q mcp [SUBCOMMAND] [OPTIONS]

Q MCP ajouter

Ajoutez ou remplacez un serveur MCP configuré.

Syntaxe : 

q mcp add [OPTIONS]
q mcp ajouter des arguments
Argument Description
--name Nom du serveur (obligatoire)
--command La commande utilisée pour lancer le serveur (obligatoire)
--scope Où ajouter le serveur. Des options :workspace, global
--env Variables d'environnement à utiliser lors du lancement du serveur. Format : key1=value1,key2=value2
--timeout Délai de lancement du serveur en millisecondes
--force Remplacer un serveur existant portant le même nom

q mcp supprimer

Supprimez un serveur de la configuration MCP.

Syntaxe : 

q mcp remove [OPTIONS]
q mcp supprimer des arguments
Argument Description
--name Nom du serveur à supprimer (obligatoire)
--scope Champ d'application à supprimer de. Des options :workspace, global

une liste MCP

Répertoriez les serveurs MCP configurés.

Syntaxe : 

q mcp list [SCOPE]
arguments de la liste q mcp
Argument Description
SCOPE Champ d'application de la liste. Options :workspace, global (argument positionnel)

une importation MCP

Importez une configuration de serveur à partir d'un autre fichier.

Syntaxe : 

q mcp import [OPTIONS] [SCOPE]
arguments d'importation q mcp
Argument Description
--file Fichier à partir duquel importer la configuration du serveur (obligatoire)
--force Remplacer un serveur existant portant le même nom
SCOPE Champ d'application dans lequel importer. Options :workspace, global (argument positionnel)

statut q mcp

Obtenez l'état d'un serveur MCP configuré.

Syntaxe : 

q mcp status [OPTIONS]
arguments d'état q mcp
Argument Description
--name Nom du serveur dont vous souhaitez obtenir le statut (obligatoire)

Les fichiers journaux

La CLI Amazon Q Developer gère des fichiers journaux qui peuvent être utiles pour le dépannage. Ces journaux sont stockés localement sur votre machine et ne sont pas envoyés à AWS.

Emplacement des fichiers journaux :

  • macOS : $TMPDIR/qlog/

  • Linux : $XDG_RUNTIME_DIR TMPDIR ou /tmp

Le niveau de journalisation peut être contrôlé en définissant la variable d'Q_LOG_LEVELenvironnement. Les valeurs valides sont :

  • error: uniquement les messages d'erreur (par défaut)

  • warn: messages d'avertissement et d'erreur

  • info: messages d'information, d'avertissement et d'erreur

  • debug: messages de débogage, d'information, d'avertissement et d'erreur

  • trace: Tous les messages, y compris les informations de suivi détaillées

Avertissement

Les fichiers journaux peuvent contenir des informations sensibles issues de vos conversations et interactions avec Amazon Q, notamment des chemins de fichiers, des extraits de code et des sorties de commande. Bien que ces journaux soient stockés uniquement sur votre machine locale et ne soient pas envoyés à AWS, vous devez faire preuve de prudence lorsque vous partagez des fichiers journaux avec d'autres personnes.

Exemple de définition du niveau de journalisation (à des fins de débogage) : 

# For bash/zsh
export Q_LOG_LEVEL=debug
q chat

# For fish
set -x Q_LOG_LEVEL debug
q chat