Referência de comando da Amazon Q CLI - Amazon Q Developer
Argumentos globaisComandosArquivos de log

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Referência de comando da Amazon Q CLI

Esta seção fornece uma referência abrangente para todos os comandos da CLI do Amazon Q Developer e seus argumentos. Use essa referência para entender as opções disponíveis para cada comando e sua sintaxe adequada.

Para obter ajuda com qualquer comando, você pode usar a --help bandeira:

q [COMMAND] --help

Argumentos globais

Os argumentos a seguir estão disponíveis com qualquer comando da Amazon Q CLI:

Argumentos globais
Argumento Forma abreviada Descrição
--verbose -v Aumente a verbosidade do registro. Pode ser repetido para obter uma saída mais detalhada:-v,,, -vv -vvv -vvvv
--help -h Mostrar informações de ajuda para o comando
--version -V Mostrar informações da versão
--help-all Ajuda de impressão para todos os subcomandos

Comandos

As seções a seguir descrevem cada comando da Amazon Q CLI e seus argumentos disponíveis.

um bate-papo

Inicie uma sessão de bate-papo interativo com o Amazon Q. Quando nenhum subcomando é especificado, o q padrão é. q chat

Sintaxe: 

q chat [OPTIONS] [INPUT]
argumentos do q chat
Argumento Forma abreviada Descrição
--no-interactive Imprima a primeira resposta para STDOUT sem o modo interativo. Isso falhará se o prompt solicitar permissões para usar uma ferramenta, a menos que também --trust-all-tools seja usada
--resume -r Retomar a conversa anterior a partir deste diretório
--profile Perfil de contexto a ser usado
--trust-all-tools Permita que o modelo use qualquer ferramenta para executar comandos sem pedir confirmação
--trust-tools Confie somente no conjunto de ferramentas especificado. Forneça uma lista separada por vírgulas dos nomes das ferramentas. Exemplo: --trust-tools=fs_read,fs_write. Para não confiar em ferramentas, use --trust-tools=
INPUT A primeira pergunta a ser feita (argumento posicional)

Exemplos: 

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"

uma tradução

Traduza instruções de linguagem natural em comandos de shell executáveis usando IA.

Sintaxe: 

q translate [OPTIONS] [INPUT...]
q traduz argumentos
Argumento Forma abreviada Descrição
--n -n Número de conclusões a serem geradas (deve ser ≤ 5)
INPUT Descrição em linguagem natural do comando que você deseja gerar (argumentos posicionais)

Exemplos: 

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"

um médico

Corrija e diagnostique problemas comuns de instalação e configuração com o Amazon Q.

Sintaxe: 

q doctor [OPTIONS]
argumentos de um médico
Argumento Forma abreviada Descrição
--all -a Execute todos os exames médicos, sem correções
--strict -s Erro nos avisos

Exemplos: 

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

uma atualização

Atualize o aplicativo Amazon Q para a versão mais recente.

Sintaxe: 

q update [OPTIONS]
q atualiza argumentos
Argumento Forma abreviada Descrição
--non-interactive -y Não solicite confirmação
--relaunch-dashboard Reinicie no painel após a atualização. O padrão é verdadeiro
--rollout Usa a implantação

Exemplos: 

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

um tema

Obtenha ou defina o tema visual para o menu suspenso de preenchimento automático. Isso afeta a aparência da janela pop-up que mostra as conclusões dos comandos.

Sintaxe: 

q theme [OPTIONS] [THEME]
argumentos do tema q
Argumento Descrição
--list Listar todos os temas disponíveis
--folder Mostrar o caminho do diretório do tema
THEME Nome do tema a ser definido. Os temas incorporados incluem:dark,light, system (argumento posicional)

Exemplos: 

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

Nota: As alterações do tema afetam a janela pop-up de preenchimento automático. Talvez seja necessário acionar sugestões de preenchimento automático para ver as alterações visuais.

integrações q

Gerencie integrações de sistemas para o Amazon Q.

Sintaxe: 

q integrations [SUBCOMMAND] [OPTIONS]

subcomandos de integrações q

subcomandos de integrações q
Subcomando Descrição
install Instale uma integração. Suporta --silent (-s) para suprimir mensagens de status
uninstall Desinstale uma integração. Suporta --silent (-s) para suprimir mensagens de status
reinstall Reinstale uma integração. Suporta --silent (-s) para suprimir mensagens de status
status Verifique o status de uma integração. Suporta --format (-f) para formato de saída

q em linha

Gerencie sugestões embutidas (texto fantasma) que aparecem diretamente na sua linha de comando enquanto você digita. Para obter mais informações, consulte Recursos de assistência de linha de comando.

Sintaxe: 

q inline [SUBCOMMAND] [OPTIONS]

q subcomandos em linha

q subcomandos em linha
Subcomando Descrição
enable Ative sugestões embutidas que aparecem enquanto você digita
disable Desativar sugestões embutidas
status Mostrar se as sugestões embutidas estão ativadas ou desativadas
set-customization Selecione um modelo de personalização para usar. Opcionalmente, especifique o ARN da personalização
show-customizations Mostrar modelos de personalização disponíveis. Suporta --format (-f) para formato de saída

Exemplos: 

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

um login

Autentique-se com o Amazon Q usando o AWS Builder ID (gratuito) ou o IAM Identity Center (Pro).

Sintaxe: 

q login [OPTIONS]
argumentos de login q
Argumento Descrição
--license Tipo de licença. Opções: free (para Builder ID), pro (para Identity Center)
--identity-provider URL do provedor de identidade (para o Identity Center)
--region Região da AWS (para o Identity Center)
--use-device-flow Sempre use o fluxo do OAuth dispositivo para autenticação. Útil quando os redirecionamentos do navegador não podem ser manipulados

Exemplos: 

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

um logout

Saia da sua sessão do Amazon Q.

Sintaxe: 

q logout

Esse comando não aceita argumentos adicionais.

um uísque

Exibir informações sobre o usuário atual e o status da autenticação.

Sintaxe: 

q whoami [OPTIONS]
argumentos de um whoami
Argumento Forma abreviada Descrição
--format -f Formato de saída. Opções: plain (padrão),json, json-pretty

um perfil

Mostra o perfil associado ao usuário atual do IAM Identity Center. Esse comando está disponível somente para usuários Pro.

Sintaxe: 

q profile

Esse comando não aceita argumentos adicionais.

configurações q

Gerencie as configurações do Amazon Q. Para obter informações detalhadas sobre o gerenciamento de configurações, consulteDefinindo as configurações do Amazon Q.

Sintaxe: 

q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
argumentos de configurações q
Argumento Forma abreviada Descrição
--delete -d Excluir uma configuração
--format -f Formato de saída. Opções: plain (padrão),json, json-pretty
KEY Chave de configuração (argumento posicional)
VALUE Valor de configuração (argumento posicional)

subcomandos de configurações q

subcomandos de configurações q
Subcomando Descrição
open Abra o arquivo de configurações no seu editor padrão
all Listar todas as configurações atuais. --formatOpção de suporte

um diagnóstico

Execute testes de diagnóstico para solucionar problemas de instalação e configuração do Amazon Q.

Sintaxe: 

q diagnostic [OPTIONS]
q argumentos diagnósticos
Argumento Forma abreviada Descrição
--format -f Formato de saída. Opções: plain (padrão),json, json-pretty
--force Saída de diagnóstico com força limitada

um problema

Crie um novo GitHub problema para comentários ou relatórios de bugs do Amazon Q.

Sintaxe: 

q issue [OPTIONS] [DESCRIPTION...]
q emite argumentos
Argumento Forma abreviada Descrição
--force -f Forçar a criação de um problema
DESCRIPTION Descrição do problema (argumentos posicionais)

versão q

Exiba as informações da versão e, opcionalmente, mostre o changelog.

Sintaxe: 

q version [OPTIONS]
argumentos da versão q
Argumento Descrição
--changelog[=VERSION] Mostre o changelog. Use --changelog para a versão atual, --changelog=all para todas as versões ou --changelog=x.x.x para uma versão específica

uma mcp

Gerencie servidores do Model Context Protocol (MCP). Para obter informações detalhadas sobre o MCP, consulteUsando o MCP com o Amazon Q Developer.

Sintaxe: 

q mcp [SUBCOMMAND] [OPTIONS]

um mcp adiciona

Adicione ou substitua um servidor MCP configurado.

Sintaxe: 

q mcp add [OPTIONS]
q mcp adiciona argumentos
Argumento Descrição
--name Nome do servidor (obrigatório)
--command O comando usado para iniciar o servidor (obrigatório)
--scope Onde adicionar o servidor. Opções:workspace, global
--env Variáveis de ambiente a serem usadas ao iniciar o servidor. Formato: key1=value1,key2=value2
--timeout Tempo limite de inicialização do servidor em milissegundos
--force Substituir um servidor existente com o mesmo nome

um mcp remove

Remova um servidor da configuração MCP.

Sintaxe: 

q mcp remove [OPTIONS]
q mcp remove argumentos
Argumento Descrição
--name Nome do servidor a ser removido (obrigatório)
--scope Escopo do qual remover. Opções:workspace, global

lista q mcp

Listar servidores MCP configurados.

Sintaxe: 

q mcp list [SCOPE]
argumentos da lista q mcp
Argumento Descrição
SCOPE Escopo a ser listado. Opções:workspace, global (argumento posicional)

importação de q mcp

Importe uma configuração de servidor de outro arquivo.

Sintaxe: 

q mcp import [OPTIONS] [SCOPE]
argumentos de importação q mcp
Argumento Descrição
--file Arquivo do qual importar a configuração do servidor (obrigatório)
--force Substituir um servidor existente com o mesmo nome
SCOPE Escopo para o qual importar. Opções:workspace, global (argumento posicional)

status q mcp

Obtenha o status de um servidor MCP configurado.

Sintaxe: 

q mcp status [OPTIONS]
argumentos de status q mcp
Argumento Descrição
--name Nome do servidor para o qual obter o status (obrigatório)

Arquivos de log

O Amazon Q Developer CLI mantém arquivos de log que podem ser úteis para a solução de problemas. Esses registros são armazenados localmente em sua máquina e não são enviados para a AWS.

Localizações dos arquivos de log:

  • macOS: $TMPDIR/qlog/

  • Linux: $XDG_RUNTIME_DIR ou TMPDIR ou /tmp

O nível do log pode ser controlado definindo a variável de Q_LOG_LEVEL ambiente. Os valores válidos são:

  • error: Somente mensagens de erro (padrão)

  • warn: Mensagens de aviso e erro

  • info: mensagens informativas, de aviso e de erro

  • debug: mensagens de depuração, informativas, de aviso e de erro

  • trace: Todas as mensagens, incluindo informações detalhadas de rastreamento

Atenção

Os arquivos de log podem conter informações confidenciais de suas conversas e interações com o Amazon Q, incluindo caminhos de arquivos, trechos de código e saídas de comandos. Embora esses registros sejam armazenados somente em sua máquina local e não sejam enviados para a AWS, você deve ter cuidado ao compartilhar arquivos de log com outras pessoas.

Exemplo de configuração do nível de registro (para fins de depuração): 

# For bash/zsh
export Q_LOG_LEVEL=debug
q chat

# For fish
set -x Q_LOG_LEVEL debug
q chat