Arguments globaux Commandes Les fichiers journaux

Référence de commande Amazon Q CLI

Cette section fournit une référence exhaustive de toutes les commandes de l’interface de ligne de commande d’Amazon Q Developer et de 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 sur une commande, vous pouvez utiliser l’indicateur --help :


q [COMMAND] --help

Arguments globaux

Les arguments suivants sont disponibles avec n’importe quelle commande de l’interface de ligne de commande d’Amazon Q :

Arguments globaux
Argument	Formule courte	Description
`--verbose`	`-v`	Augmenter le niveau de détail des journaux. Peut être répété pour obtenir une sortie plus détaillée : `-v`, `-vv`, `-vvv`, `-vvvv`
`--help`	`-h`	Afficher l’aide de la commande
`--version`	`-V`	Afficher la version
`--help-all`		Imprimer l’aide de toutes les sous-commandes

Commandes

Les sections suivantes décrivent chaque commande de l’interface de ligne de commande d’Amazon Q et ses arguments disponibles.

q chat

Démarre une session de chat interactif avec Amazon Q. Lorsqu’aucune sous-commande n’est spécifiée, q prend par défaut la valeur q chat.

Syntaxe :


q chat [OPTIONS] [INPUT]

Arguments de q chat
Argument	Formule courte	Description
`--no-interactive`		Imprimer la première réponse à STDOUT sans mode interactif. Cette opération échoue si l’invite demande l’autorisation d’utiliser un outil, à moins que `--trust-all-tools` soit également utilisé
`--resume`	`-r`	Reprendre la conversation précédente de ce répertoire
`--agent`		Agent à 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 faire confiance qu’à l’ensemble d’outils spécifié. Fournir 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`		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 --agent my-agent "Help me with AWS CLI"

q translate

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

Syntaxe :


q translate [OPTIONS] [INPUT...]

Arguments de q translate
Argument	Formule courte	Description
`--n`	`-n`	Nombre de saisies à 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"

q doctor

Diagnostiquer et corriger les problèmes courants d’installation et de configuration avec Amazon Q.

Syntaxe :


q doctor [OPTIONS]

Arguments de q doctor
Argument	Formule courte	Description
`--all`	`-a`	Exécuter tous les tests de la commande doctor, sans aucun correctif
`--strict`	`-s`	Erreur sur les avertissements

Exemples :


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

q update

Mettre à jour l’application Amazon Q.

Syntaxe :


q update [OPTIONS]

Arguments de q update
Argument	Formule courte	Description
`--non-interactive`	`-y`	Ne pas demander de confirmation
`--relaunch-dashboard`		Relancer le tableau de bord après la mise à jour. La valeur par défaut est true
`--rollout`		Utiliser des déploiements

Exemples :


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

q theme

Obtenir ou définir le thème visuel du menu déroulant à saisie semi-automatique. Cela affecte l’apparence de la fenêtre contextuelle qui affiche la saisie semi-automatique des commandes.

Syntaxe :


q theme [OPTIONS] [THEME]

Arguments de q theme
Argument	Description
`--list`	Répertorier tous les thèmes disponibles
`--folder`	Afficher le chemin du répertoire des thèmes
`THEME`	Nom du thème à spécifier. 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 semi-automatique. Vous devrez peut-être déclencher des suggestions de saisie semi-automatique pour voir les modifications visuelles.

q integrations

Gérer les intégrations système pour Amazon Q.

Syntaxe :


q integrations [SUBCOMMAND] [OPTIONS]

Sous-commandes de q integrations

Sous-commandes de q integrations
Sous-commande	Description
`install`	Installer une intégration. Prend en charge `--silent` (`-s`) pour supprimer les messages de statut
`uninstall`	Désinstaller une intégration. Prend en charge `--silent` (`-s`) pour supprimer les messages de statut
`reinstall`	Réinstaller une intégration. Prend en charge `--silent` (`-s`) pour supprimer les messages de statut
`status`	Vérifier le statut d’une intégration. Prend en charge `--format` (`-f`) pour le format de la sortie

q inline

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

Syntaxe :


q inline [SUBCOMMAND] [OPTIONS]

Sous-commandes de q inline

Sous-commandes de q inline
Sous-commande	Description
`enable`	Activer les suggestions intégrées qui s’affichent 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électionner un modèle de personnalisation à utiliser. Spécifier éventuellement l’ARN de la personnalisation
`show-customizations`	Afficher les modèles de personnalisation disponibles. Prend en charge `--format` (`-f`) pour le format de la 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

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 q login
Argument	Description
`--license`	Type de licence. Options : `free` (pour l’ID de créateur), `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

q logout

Se déconnecter de la session Amazon Q.

Syntaxe :


q logout

Cette commande ne prend aucun argument supplémentaire.

q whoami

Afficher les informations relatives à l’utilisateur en cours et au statut de l’authentification.

Syntaxe :


q whoami [OPTIONS]

Arguments de q whoami
Argument	Formule courte	Description
`--format`	`-f`	Format de la sortie. Options : `plain` (par défaut), `json`, `json-pretty`

q profile

Afficher le profil associé à l’utilisateur IAM Identity Center en cours. Cette commande est réservée aux utilisateurs Pro.

Syntaxe :


q profile

Cette commande ne prend aucun argument supplémentaire.

q settings

Gérer les paramètres de configuration d’Amazon Q. Pour plus d’informations sur la gestion des paramètres, consultez Configurer les paramètres Amazon Q.

Syntaxe :


q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]

Arguments de q settings
Argument	Formule courte	Description
`--delete`	`-d`	Supprimer un paramètre
`--format`	`-f`	Format de la sortie. Options : `plain` (par défaut), `json`, `json-pretty`
`KEY`		Clé des paramètres (argument positionnel)
`VALUE`		Valeur des paramètres (argument positionnel)

Sous-commandes de q settings

Sous-commandes de q settings
Sous-commande	Description
`open`	Ouvrir le fichier de paramètres dans votre éditeur par défaut
`list`	Répertoriez les paramètres configurés. Permet `--all` d'afficher tous les paramètres disponibles avec des descriptions. Prend en charge l’option `--format`
`all`	(Obsolète) Répertoriez tous les paramètres actuels. Utilisez `list` à la place. Prend en charge l’option `--format`

/invite

Gérez des modèles d'invite réutilisables pour les interactions par chat. Pour des informations complètes sur la gestion des promptes et les arguments, consultezGérer les invites.

Syntaxe :


/prompts [SUBCOMMAND] [OPTIONS] [NAME] [ARGUMENTS...]

/invite les arguments
Argument	Description
`NAME`	Nom de l'invite (pour plus de détails, créer, modifier, supprimer des commandes)
`ARGUMENTS...`	Arguments à transmettre à l'invite lors de l'utilisation de `get` la commande

sous-commandes /prompts

sous-commandes /prompts
Sous-commande	Description
`list [search-word]`	Répertorier les invites disponibles, éventuellement filtrées par mot de recherche
`details <name>`	Afficher des informations détaillées sur une invite, y compris les arguments, l'utilisation et les exemples
`get <name> [args...]`	Récupérez et exécutez une invite avec des arguments facultatifs
`create --name <name> [--content text] [--global]`	Créez une nouvelle invite. Ouvre l'éditeur si aucun contenu n'est fourni
`edit <name> [--global]`	Modifier une invite existante dans votre éditeur par défaut
`remove <name> [--global]`	Supprimer une invite existante (nécessite une confirmation)

Utilisation des instructions dans le chat

Les invites peuvent être invoquées directement dans le chat à l'aide du préfixe @ :


@<prompt-name> [arguments...]

Exemples :

# 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"

Arguments rapides

Les invites peuvent accepter des arguments pour personnaliser leur comportement :

Arguments obligatoires : doivent être fournis, affichés sous la forme <arg>
Arguments facultatifs : peuvent être omis, affichés sous la forme [arg]
Arguments entre guillemets : utilisez des guillemets pour les arguments contenant des espaces

/prompts details <name>À utiliser pour découvrir les arguments acceptés par une invite.

q diagnostic

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

Syntaxe :


q diagnostic [OPTIONS]

Arguments de q diagnostic
Argument	Formule courte	Description
`--format`	`-f`	Format de la sortie. Options : `plain` (par défaut), `json`, `json-pretty`
`--force`		Forcer une sortie de diagnostic limitée

q issue

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 de q issue
Argument	Formule courte	Description
`--force`	`-f`	Forcer la création d’un problème
`DESCRIPTION`		Description du problème (arguments positionnels)

q version

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

Syntaxe :


q version [OPTIONS]

Arguments de q version
Argument	Description
`--changelog[=VERSION]`	Afficher le journal des modifications. Utiliser `--changelog` pour la version en cours, `--changelog=all` pour toutes les versions ou `--changelog=x.x.x` pour une version spécifique

q mcp

Gérer les serveurs MCP (Model Context Protocol). Pour plus d’informations sur les serveurs MCP, consultez Utilisation de serveurs MCP avec Amazon Q Developer.

Syntaxe :


q mcp [SUBCOMMAND] [OPTIONS]

q mcp add

Ajouter ou remplacer un serveur MCP configuré.

Syntaxe :


q mcp add [OPTIONS]

Arguments de q mcp add
Argument	Description
`--name`	Nom du serveur (obligatoire)
`--command`	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 d’expiration du lancement du serveur en millisecondes
`--force`	Remplacer un serveur existant par un serveur du même nom

q mcp remove

Supprimer un serveur de la configuration MCP.

Syntaxe :


q mcp remove [OPTIONS]

Arguments de q mcp remove
Argument	Description
`--name`	Nom du serveur à supprimer (obligatoire)
`--scope`	Portée de laquelle supprimer le serveur. Des options :`workspace`, `global`

q mcp list

Répertorier les serveurs MCP configurés.

Syntaxe :


q mcp list [SCOPE]

Arguments de q mcp list
Argument	Description
`SCOPE`	Portée à répertorier. Options : `workspace`, `global` (argument positionnel)

q mcp import

Importer une configuration de serveur d’un autre fichier.

Syntaxe :


q mcp import [OPTIONS] [SCOPE]

Arguments de q mcp import
Argument	Description
`--file`	Fichier duquel importer la configuration du serveur (obligatoire)
`--force`	Remplacer un serveur existant par un serveur du même nom
`SCOPE`	Portée dans laquelle effectuer l’importation. Options : `workspace`, `global` (argument positionnel)

q mcp status

Obtenir le statut d’un serveur MCP configuré.

Syntaxe :


q mcp status [OPTIONS]

Arguments de q mcp status
Argument	Description
`--name`	Nom du serveur dont vous souhaitez obtenir le statut (obligatoire)

Les fichiers journaux

L’interface de ligne de commande d’Amazon Q Developer gère des fichiers journaux qui peuvent être utiles pour la résolution des problèmes. 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’environnement Q_LOG_LEVEL. Les valeurs valides sont :

error : uniquement les messages d’erreur (par défaut)
warn : messages d’erreur et d’avertissement
info : messages d’information, d’avertissement et d’erreur
debug : messages d’erreur, d’avertissement, d’information et de débogage
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

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Paramètres relatifs à l'agent

Assistance de la ligne de commande