Referencia de comandos de la CLI de Amazon Q - Amazon Q Developer
Argumentos globalesComandosArchivos de registro

Referencia de comandos de la CLI de Amazon Q

En esta sección se proporciona una referencia completa de todos los comandos de la CLI de Amazon Q Developer y sus argumentos. Utilice esta referencia para comprender las opciones disponibles para cada comando y su sintaxis correcta.

Si necesita ayuda con cualquier comando, puede usar el indicador --help:

q [COMMAND] --help

Argumentos globales

Los siguientes argumentos están disponibles con cualquier comando de la CLI de Amazon Q:

Argumentos globales
Argumento Forma abreviada Descripción
--verbose -v Aumenta el nivel de detalle del registro. Se puede repetir para obtener un resultado más detallado: -v, -vv, -vvv y -vvvv
--help -h Muestra la información de ayuda del comando.
--version -V Muestra la información de la versión.
--help-all Imprime la ayuda para todos los subcomandos.

Comandos

En las siguientes secciones se describe cada comando de la CLI de Amazon Q y sus argumentos disponibles.

q chat

Inicie una sesión de chat interactivo con Amazon Q. Si no se especifica ningún subcomando, q se establece de forma predeterminada en q chat.

Sintaxis: 

q chat [OPTIONS] [INPUT]
Argumentos de q chat
Argumento Forma abreviada Descripción
--no-interactive Imprime la primera respuesta a STDOUT sin el modo interactivo. Se producirá un error si la petición pide permisos para usar una herramienta, a no ser que también se use --trust-all-tools.
--resume -r Reanuda la conversación anterior desde este directorio.
--agent Agente que se va a utilizar.
--trust-all-tools Permite que el modelo utilice cualquier herramienta para ejecutar comandos sin solicitar confirmación.
--trust-tools Confía únicamente en el conjunto de herramientas especificado. Proporciona una lista de nombres de herramientas separados por comas. Ejemplo: --trust-tools=fs_read,fs_write. Para no confiar en ninguna herramienta, utilice --trust-tools=.
INPUT La primera pregunta que se va a formular (argumento posicional).

Ejemplos: 

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

Traduzca instrucciones en lenguaje natural a comandos de intérprete de comandos ejecutables mediante la IA.

Sintaxis: 

q translate [OPTIONS] [INPUT...]
Argumentos de q translate
Argumento Forma abreviada Descripción
--n -n Número de finalizaciones que se van a generar (debe ser ≤ 5).
INPUT Descripción en lenguaje natural del comando que se desea generar (argumentos de posición).

Ejemplos: 

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

Solucione y diagnostique problemas frecuentes de instalación y configuración con Amazon Q.

Sintaxis: 

q doctor [OPTIONS]
Argumentos de q doctor
Argumento Forma abreviada Descripción
--all -a Realiza todas las pruebas de doctor sin realizar ninguna corrección.
--strict -s Error en las advertencias.

Ejemplos: 

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

q update

Actualice la aplicación de Amazon Q a la versión más reciente.

Sintaxis: 

q update [OPTIONS]
Argumentos de q update
Argumento Forma abreviada Descripción
--non-interactive -y No se pide confirmación.
--relaunch-dashboard Vuelve a iniciarse en el panel tras la actualización. El valor predeterminado es true.
--rollout Utiliza la implementación.

Ejemplos: 

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

q theme

Obtenga o establezca el tema visual para el menú desplegable Autocompletar. Esto afecta a la apariencia de la ventana emergente que muestra la finalización de los comandos.

Sintaxis: 

q theme [OPTIONS] [THEME]
Argumentos de q theme
Argumento Descripción
--list Enumera todos los temas disponibles.
--folder Muestra la ruta del directorio de temas.
THEME El nombre del tema que va a establecerse. Entre los temas integrados se incluyen: dark, light y system (argumento de posición).

Ejemplos: 

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

Nota: Los cambios de tema afectan a la ventana emergente Autocompletar. Es posible que tenga que desencadenar las sugerencias de autocompletar para ver los cambios visuales.

q integrations

Administre las integraciones de sistemas para Amazon Q.

Sintaxis: 

q integrations [SUBCOMMAND] [OPTIONS]

Subcomandos de q integrations

Subcomandos de q integrations
Subcomando Descripción
install Instala una integración. Admite --silent (-s) para suprimir los mensajes de estado.
uninstall Desinstala una integración. Admite --silent (-s) para suprimir los mensajes de estado.
reinstall Vuelve a instalar una integración. Admite --silent (-s) para suprimir los mensajes de estado.
status Comprueba el estado de una integración. Admite --format (-f) para el formato de salida.

q inline

Administre las sugerencias de inserción (texto fantasma) que aparecen directamente en la línea de comandos a medida que escribe. Para obtener más información, consulte Características de asistencia de línea de comandos

Sintaxis: 

q inline [SUBCOMMAND] [OPTIONS]

Subcomandos de q inline

Subcomandos de q inline
Subcomando Descripción
enable Habilita las sugerencias de inserción que aparecen a medida que escribe.
disable Deshabilita las sugerencias de inserción.
status Muestra si las sugerencias de inserción están habilitadas o deshabilitadas.
set-customization Se selecciona el modelo de personalización que se va utilizar. También se puede especificar el ARN de la personalización.
show-customizations Muestra los modelos de personalización disponibles. Admite --format (-f) para el formato de salida.

Ejemplos: 

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

Autentique con Amazon Q mediante el ID de creador de AWS (gratuito) o el IAM Identity Center (Pro).

Sintaxis: 

q login [OPTIONS]
Argumentos de q login
Argumento Descripción
--license Tipo de licencia. Opciones: free (para el ID de creador), pro (para el Identity Center).
--identity-provider URL del proveedor de identidad (para el Identity Center).
--region Región de AWS (para el Identity Center).
--use-device-flow Se requiere utilizar siempre el flujo de dispositivos de OAuth para la autenticación. Una opción útil cuando los redireccionamientos del navegador no se pueden gestionar.

Ejemplos: 

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

Cierre la sesión en Amazon Q.

Sintaxis: 

q logout

Este comando no admite argumentos adicionales.

q whoami

Muestra información sobre el usuario actual y el estado de autenticación.

Sintaxis: 

q whoami [OPTIONS]
Argumentos de q whoami
Argumento Forma abreviada Descripción
--format -f Formato de salida. Opciones: plain (de forma predeterminada), json y json-pretty

q profile

Muestra el perfil asociado al usuario actual del IAM Identity Center. Este comando solo está disponible para usuarios Pro.

Sintaxis: 

q profile

Este comando no admite argumentos adicionales.

q settings

Administre los ajustes de configuración de Amazon Q. Para obtener información detallada sobre la administración de la configuración, consulte Configuración de los ajustes de Amazon Q.

Sintaxis: 

q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
Argumentos de q settings
Argumento Forma abreviada Descripción
--delete -d Elimina una configuración.
--format -f Formato de salida. Opciones: plain (de forma predeterminada), json y json-pretty
KEY Clave de configuración (argumento de posición)
VALUE Valor de configuración (argumento de posición)

Subcomandos de q settings

Subcomandos de q settings
Subcomando Descripción
open Abre el archivo de configuración en el editor predeterminado.
all Enumera todos los ajustes actuales. Admite la opción --format.

q diagnostic

Ejecute pruebas de diagnóstico para solucionar los problemas de instalación y configuración de Amazon Q.

Sintaxis: 

q diagnostic [OPTIONS]
Argumentos de q diagnostic
Argumento Forma abreviada Descripción
--format -f Formato de salida. Opciones: plain (de forma predeterminada), json y json-pretty
--force Fuerza el resultado de diagnóstico limitado.

q issue

Cree un nuevo problema de GitHub para los comentarios o informes de errores de Amazon Q.

Sintaxis: 

q issue [OPTIONS] [DESCRIPTION...]
Argumentos de q issue
Argumento Forma abreviada Descripción
--force -f Fuerza la creación de problemas.
DESCRIPTION Descripción del problema (argumentos de posición).

q version

Muestra la información de la versión y, opcionalmente, muestra el registro de cambios.

Sintaxis: 

q version [OPTIONS]
Argumentos de q version
Argumento Descripción
--changelog[=VERSION] Muestra el registro de cambios. Utilice --changelog para la versión actual, --changelog=all para todas las versiones o --changelog=x.x.x para una determinada versión.

q mcp

Administre los servidores del Protocolo de contexto para modelos (MCP). Para obtener información detallada sobre el MCP, consulte Uso del MCP con Amazon Q Developer.

Sintaxis: 

q mcp [SUBCOMMAND] [OPTIONS]

q mcp add

Añada o sustituya un servidor MCP configurado.

Sintaxis: 

q mcp add [OPTIONS]
Argumentos de q mcp add
Argumento Descripción
--name Nombre del servidor (obligatorio).
--command El comando utilizado para iniciar el servidor (obligatorio).
--scope La ubicación en la que añadir el servidor. Opciones: workspace y global.
--env Variables de entorno que se utilizarán al iniciar el servidor. Formato: key1=value1,key2=value2
--timeout Tiempo de espera de inicio del servidor en milisegundos.
--force Sobrescribe un servidor existente con el mismo nombre.

q mcp remove

Elimine un servidor de la configuración del MCP.

Sintaxis: 

q mcp remove [OPTIONS]
Argumentos de q mcp remove
Argumento Descripción
--name Nombre del servidor que se va a eliminar (obligatorio).
--scope Alcance del que se eliminará. Opciones: workspace y global.

q mcp list

Enumere los servidores MCP configurados.

Sintaxis: 

q mcp list [SCOPE]
Argumentos de q mcp list
Argumento Descripción
SCOPE Alcance que se va a enumerar. Opciones: workspace y global (argumento de posición)

q mcp import

Importe una configuración de servidor desde otro archivo.

Sintaxis: 

q mcp import [OPTIONS] [SCOPE]
Argumentos de q mcp import
Argumento Descripción
--file Archivo desde el que importar la configuración del servidor (obligatorio).
--force Sobrescribe un servidor existente con el mismo nombre.
SCOPE Ámbito al que se va a importar. Opciones: workspace y global (argumento de posición)

q mcp status

Obtenga el estado de un servidor MCP configurado.

Sintaxis: 

q mcp status [OPTIONS]
Argumentos de q mcp status
Argumento Descripción
--name Nombre del servidor del que se va a obtener el estado (obligatorio).

Archivos de registro

La CLI de Amazon Q Developer mantiene archivos de registro que pueden ser útiles para solucionar problemas. Estos registros se almacenan localmente en el equipo y no se envían a AWS.

Ubicaciones de archivo de registro:

  • macOS: $TMPDIR/qlog/

  • Linux: $XDG_RUNTIME_DIR, TMPDIR o /tmp

Establezca la variable de entorno de Q_LOG_LEVEL para controlar el nivel de registro. Los valores válidos son:

  • error: solo mensajes de error (opción predeterminada)

  • warn: mensajes de error y advertencia

  • info: mensajes de error, advertencia e información

  • debug: mensajes de error, advertencia, información y depuración

  • trace: todos los mensajes, incluida información de seguimiento detallada

aviso

Los archivos de registro pueden incluir información confidencial de las conversaciones e interacciones con Amazon Q, incluidas rutas de archivos, fragmentos de código y resultados de comandos. Aunque estos registros solo se almacenen en el equipo local y no se envíen a AWS, debe tener cuidado al compartir archivos de registro con otras personas.

Ejemplo de configuración del nivel de registro (con fines de depuración): 

# For bash/zsh
export Q_LOG_LEVEL=debug
q chat

# For fish
set -x Q_LOG_LEVEL debug
q chat