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

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Referencia de comandos de la CLI de Amazon Q

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

Si necesitas ayuda con cualquier comando, puedes usar la --help marca:

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 Aumente la verbosidad del registro. Se puede repetir para obtener un resultado más detallado:,,, -v -vv -vvv -vvvv
--help -h Muestra información de ayuda para el comando
--version -V Mostrar información sobre la versión
--help-all Imprima 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.

un chat

Inicie una sesión de chat interactivo con Amazon Q. Si no se especifica ningún subcomando, el q valor predeterminado es. q chat

Sintaxis: 

q chat [OPTIONS] [INPUT]
q: argumentos de chat
Argumento Forma abreviada Descripción
--no-interactive Imprima la primera respuesta a STDOUT sin modo interactivo. Esto fallará si la solicitud solicita permisos para usar una herramienta, a menos que también --trust-all-tools se use
--resume -r Reanude la conversación anterior desde este directorio
--profile Perfil de contexto que se va a utilizar
--trust-all-tools Permita que el modelo utilice cualquier herramienta para ejecutar comandos sin solicitar confirmación
--trust-tools Confíe únicamente en el conjunto de herramientas especificado. Proporcione 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 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 --profile my-profile "Help me with AWS CLI"

q traducir

Translate instrucciones en lenguaje natural a comandos de shell ejecutables mediante IA.

Sintaxis: 

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

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"

¿un médico

Solucionar y diagnosticar problemas comunes de instalación y configuración con Amazon Q.

Sintaxis: 

q doctor [OPTIONS]
Argumentos de un doctor
Argumento Forma abreviada Descripción
--all -a Realiza todas las pruebas médicas, sin soluciones
--strict -s Error en las advertencias

Ejemplos: 

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

una actualización

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

Sintaxis: 

q update [OPTIONS]
q: actualiza los argumentos
Argumento Forma abreviada Descripción
--non-interactive -y No solicite confirmación
--relaunch-dashboard Vuelva a iniciarlo en el panel de control tras la actualización. El valor predeterminado es true
--rollout Utiliza rollout

Ejemplos: 

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

un tema

Obtén o establece el tema visual para el menú desplegable de autocompletar. Esto afecta a la apariencia de la ventana emergente que muestra la finalización de los comandos.

Sintaxis: 

q theme [OPTIONS] [THEME]
q: argumentos del tema
Argumento Descripción
--list Enumere todos los temas disponibles
--folder Muestra la ruta del directorio de temas
THEME Nombre del tema que se va a configurar. Los temas integrados incluyen:dark,light, system (argumento posicional)

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 de autocompletado. Puede que tengas que activar las sugerencias de autocompletar para ver los cambios visuales.

q integraciones

Gestione las integraciones de sistemas para Amazon Q.

Sintaxis: 

q integrations [SUBCOMMAND] [OPTIONS]

q integraciones y subcomandos

q: subcomandos de integraciones
Subcomando Descripción
install Instala una integración. Admite --silent (-s) para suprimir los mensajes de estado
uninstall Desinstalar una integración. Admite --silent (-s) para suprimir los mensajes de estado
reinstall Vuelva a instalar una integración. Admite --silent (-s) para suprimir los mensajes de estado
status Compruebe el estado de una integración. Soporta --format (-f) para el formato de salida

q en línea

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

Sintaxis: 

q inline [SUBCOMMAND] [OPTIONS]

q: subcomandos en línea

q subcomandos en línea
Subcomando Descripción
enable Activa las sugerencias en línea que aparecen a medida que escribes
disable Desactiva las sugerencias en línea
status Muestra si las sugerencias en línea están habilitadas o deshabilitadas
set-customization Seleccione el modelo de personalización que desee utilizar. Si lo desea, especifique el ARN de la personalización
show-customizations Muestra los modelos de personalización disponibles. Soporta --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 inicio de sesión

Autenticate con Amazon Q mediante AWS Builder ID (gratuito) o IAM Identity Center (Pro).

Sintaxis: 

q login [OPTIONS]
q: argumentos de inicio de sesión
Argumento Descripción
--license Tipo de licencia. Opciones: free (para Builder ID), pro (para Identity Center)
--identity-provider URL del proveedor de identidad (para Identity Center)
--region Región de AWS (para Identity Center)
--use-device-flow Utilice siempre el flujo de OAuth dispositivos para la autenticació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 cierre de sesión

Cierra la sesión de Amazon Q.

Sintaxis: 

q logout

Este comando no admite argumentos adicionales.

Soy un 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 (por defecto)json, json-pretty

un perfil

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.

configuración q

Administra los ajustes de configuración de Amazon Q. Para obtener información detallada sobre la administración de la configuración, consulteConfiguración de los ajustes de Amazon Q.

Sintaxis: 

q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
q establece argumentos
Argumento Forma abreviada Descripción
--delete -d Eliminar un ajuste
--format -f Formato de salida. Opciones: plain (por defecto)json, json-pretty
KEY Tecla de configuración (argumento posicional)
VALUE Valor de ajuste (argumento posicional)

q configura subcomandos

q: subcomandos de configuración
Subcomando Descripción
open Abre el archivo de configuración en tu editor predeterminado
all Enumera todos los ajustes actuales. Soporta --format la opción

un diagnóstico

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

Sintaxis: 

q diagnostic [OPTIONS]
q: argumentos de diagnóstico
Argumento Forma abreviada Descripción
--format -f Formato de salida. Opciones: plain (por defecto)json, json-pretty
--force Salida de diagnóstico con fuerza limitada

¿un problema

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

Sintaxis: 

q issue [OPTIONS] [DESCRIPTION...]
q: problema, argumentos
Argumento Forma abreviada Descripción
--force -f Forzar la creación de problemas
DESCRIPTION Descripción del problema (argumentos posicionales)

versión q

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

Sintaxis: 

q version [OPTIONS]
argumentos de la versión q
Argumento Descripción
--changelog[=VERSION] Muestra el registro de cambios. Úselo --changelog para la versión actual, --changelog=all para todas las versiones o --changelog=x.x.x para una versión específica

un mcp

Administre los servidores del Model Context Protocol (MCP). Para obtener información detallada sobre el MCP, consulte. Uso de MCP con Amazon Q Developer

Sintaxis: 

q mcp [SUBCOMMAND] [OPTIONS]

q mcp add

Agregue o reemplace un servidor MCP configurado.

Sintaxis: 

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

una eliminación de mcp

Elimine un servidor de la configuración del MCP.

Sintaxis: 

q mcp remove [OPTIONS]
q mcp elimina argumentos
Argumento Descripción
--name Nombre del servidor que se va a eliminar (obligatorio)
--scope Ámbito desde el que se va a eliminar. Opciones:workspace, global

una lista mcp

Listar los servidores MCP configurados.

Sintaxis: 

q mcp list [SCOPE]
q mcp enumera los argumentos
Argumento Descripción
SCOPE Ámbito de la lista. Opciones:workspace, global (argumento posicional)

una importación mcp

Importe una configuración de servidor desde otro archivo.

Sintaxis: 

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

un estado mcp

Obtenga el estado de un servidor MCP configurado.

Sintaxis: 

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

Archivos de registro

La CLI para desarrolladores de Amazon Q mantiene archivos de registro que pueden ser útiles para solucionar problemas. Estos registros se almacenan localmente en su máquina y no se envían a AWS.

Ubicaciones de los archivos de registro:

  • macOS: $TMPDIR/qlog/

  • Linux: $XDG_RUNTIME_DIR TMPDIR o /tmp

El nivel de registro se puede controlar configurando la variable de Q_LOG_LEVEL entorno. Los valores válidos son:

  • error: Solo mensajes de error (predeterminado)

  • warn: Mensajes de advertencia y error

  • info: Mensajes informativos, de advertencia y de error

  • debug: Mensajes de depuración, informativos, de advertencia y de error

  • trace: Todos los mensajes incluyen información de rastreo detallada

aviso

Los archivos de registro pueden contener información confidencial de sus conversaciones e interacciones con Amazon Q, incluidas las rutas de los archivos, los fragmentos de código y los resultados de los comandos. Si bien estos registros solo se almacenan en su máquina local y no se envían 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