Argumentos globais Comandos Arquivos de log

Referência de comandos do Amazon Q CLI

Esta seção fornece uma referência abrangente de 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 o sinalizador --help:


q [COMMAND] --help

Argumentos globais

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

Argumentos globais
Argumento	Forma abreviada	Description
`--verbose`	`-v`	Aumenta o detalhamento do log. Pode ser repetido para obter uma saída mais detalhada: `-v`, `-vv`, `-vvv`, `-vvvv`
`--help`	`-h`	Mostra as informações de ajuda do comando
`--version`	`-V`	Mostra informações de versão
`--help-all`		Imprime a ajuda para todos os subcomandos

Comandos

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

q chat

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

Sintaxe:


q chat [OPTIONS] [INPUT]

Argumentos do q chat
Argumento	Forma abreviada	Description
`--no-interactive`		Imprime a primeira resposta para STDOUT sem o modo interativo. Essa ação falhará se o prompt solicitar permissões para usar uma ferramenta, a menos que `--trust-all-tools` também seja usado
`--resume`	`-r`	Retoma a conversa anterior com base neste diretório
`--agent`		O agente a ser usado
`--trust-all-tools`		Permite que o modelo use qualquer ferramenta para executar comandos sem pedir confirmação
`--trust-tools`		Confia somente no conjunto de ferramentas especificado. Forneça uma lista de nomes de ferramentas separados por vírgulas. 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 --agent my-agent "Help me with AWS CLI"

q translate

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

Sintaxe:


q translate [OPTIONS] [INPUT...]

Argumentos do q translate
Argumento	Forma abreviada	Description
`--n`	`-n`	O número de conclusões a serem geradas (deve ser igual ou menor que 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"

q doctor

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

Sintaxe:


q doctor [OPTIONS]

Argumentos do q doctor
Argumento	Forma abreviada	Description
`--all`	`-a`	Executa todos os testes do doctor, sem correções
`--strict`	`-s`	Erro nos avisos

Exemplos:


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

q update

Atualize a aplicação Amazon Q para a versão mais recente.

Sintaxe:


q update [OPTIONS]

Argumentos do q update
Argumento	Forma abreviada	Description
`--non-interactive`	`-y`	Não solicita confirmação
`--relaunch-dashboard`		Reinicia no painel após a atualização. O padrão é true (verdadeiro)
`--rollout`		Usa a reversão

Exemplos:


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

q theme

Obtenha ou defina o tema visual do 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 q theme
Argumento	Description
`--list`	Lista todos os temas disponíveis
`--folder`	Mostra o caminho do diretório do tema
`THEME`	Nome do tema a ser definido. Os temas incorporados incluem: `dark`, `light` e `system` (argumento posicional)

Exemplos:


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

Observação: as alterações de tema afetam a janela pop-up de preenchimento automático. Talvez seja necessário acionar as sugestões de preenchimento automático para exibir as alterações visuais.

q integrations

Gerencie integrações de sistemas no Amazon Q.

Sintaxe:


q integrations [SUBCOMMAND] [OPTIONS]

Subcomandos do q integrations

Subcomandos do q integrations
Subcomando	Description
`install`	Instala uma integração. Compatível com `--silent` ( `-s`) para suprimir mensagens de status
`uninstall`	Desinstala uma integração. Compatível com `--silent` ( `-s`) para suprimir mensagens de status
`reinstall`	Reinstala uma integração. Compatível com `--silent` ( `-s`) para suprimir mensagens de status
`status`	Verifica o status de uma integração. Compatível com `--format` ( `-f`) para o formato de saída

q inline

Gerencia as sugestões em linha (texto fantasma) que aparecem diretamente na linha de comandos enquanto você digita. Para obter mais informações, consulte Recursos de assistência da linha de comandos.

Sintaxe:


q inline [SUBCOMMAND] [OPTIONS]

Subcomandos do q inline

Subcomandos do q inline
Subcomando	Description
`enable`	Ativa sugestões em linha que aparecem à medida que você digita
`disable`	Desabilita sugestões em linha
`status`	Mostra se as sugestões em linha estão habilitadas ou desabilitadas
`set-customization`	Seleciona um modelo de personalização para usar. Opcionalmente, especifica o ARN da personalização
`show-customizations`	Mostra os modelos de personalização disponíveis. Compatível com `--format` ( `-f`) para o 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

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

Sintaxe:


q login [OPTIONS]

Argumentos do q login
Argumento	Description
`--license`	Tipo de licença. Opções: `free` (para o Builder ID), `pro` (para o Centro de Identidade)
`--identity-provider`	URL do provedor de identidade (para o Centro de Identidade)
`--region`	Região da AWS (para o Centro de Identidade)
`--use-device-flow`	Sempre use o fluxo do OAuth dispositivo para autenticação. Útil quando os redirecionamentos de 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

q logout

Encerre sua sessão do Amazon Q.

Sintaxe:


q logout

Esse comando não aceita argumentos adicionais.

q whoami

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

Sintaxe:


q whoami [OPTIONS]

Argumentos do q whoami
Argumento	Forma abreviada	Description
`--format`	`-f`	Formato de saída. Opções: `plain` (padrão), `json`, `json-pretty`

q profile

Exiba o perfil associado ao usuário atual do Centro de Identidade do IAM. Esse comando está disponível somente para usuários Pro.

Sintaxe:


q profile

Esse comando não aceita argumentos adicionais.

q settings

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

Sintaxe:


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

Argumentos do q settings
Argumento	Forma abreviada	Description
`--delete`	`-d`	Exclui 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 do q settings

Subcomandos do q settings
Subcomando	Description
`open`	Abre o arquivo de configurações no seu editor padrão
`list`	Listar as configurações definidas. Use `--all` para mostrar todas as configurações disponíveis com descrições. Compatível com a opção `--format`
`all`	(Obsoleto) Listar todas as configurações atuais. Use `list` em vez disso. Compatível com a opção `--format`

/prompts

Gerencie modelos de prompt reutilizáveis para interações de bate-papo. Para obter informações abrangentes sobre gerenciamento imediato e argumentos, consulteGerenciar solicitações.

Sintaxe:


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

/solicita argumentos
Argumento	Description
`NAME`	Nome do prompt (para obter detalhes, criar, editar, remover comandos)
`ARGUMENTS...`	Argumentos a serem passados para o prompt ao usar o `get` comando

subcomandos /prompts

subcomandos /prompts
Subcomando	Description
`list [search-word]`	Listar os prompts disponíveis, opcionalmente filtrados por palavra de pesquisa
`details <name>`	Mostrar informações detalhadas sobre um prompt, incluindo argumentos, uso e exemplos
`get <name> [args...]`	Recupere e execute um prompt com argumentos opcionais
`create --name <name> [--content text] [--global]`	Crie um novo prompt. Abre o editor se nenhum conteúdo for fornecido
`edit <name> [--global]`	Edite um prompt existente em seu editor padrão
`remove <name> [--global]`	Remover um prompt existente (requer confirmação)

Usando prompts no chat

Os prompts podem ser invocados diretamente no chat usando o prefixo @:


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

Exemplos:

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

Argumentos rápidos

Os prompts podem aceitar argumentos para personalizar seu comportamento:

Argumentos obrigatórios: devem ser fornecidos, mostrados como <arg>
Argumentos opcionais: podem ser omitidos, mostrados como [arg]
Argumentos entre aspas: use aspas para argumentos contendo espaços

Use /prompts details <name> para descobrir quais argumentos um prompt aceita.

q diagnostic

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

Sintaxe:


q diagnostic [OPTIONS]

Argumentos do q diagnostic
Argumento	Forma abreviada	Description
`--format`	`-f`	Formato de saída. Opções: `plain` (padrão), `json`, `json-pretty`
`--force`		Força a saída de diagnóstico limitada

q issue

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

Sintaxe:


q issue [OPTIONS] [DESCRIPTION...]

Argumentos do q issue
Argumento	Forma abreviada	Description
`--force`	`-f`	Força a criação de issues
`DESCRIPTION`		Descrição do problema (argumentos posicionais)

q version

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

Sintaxe:


q version [OPTIONS]

Argumentos do q version
Argumento	Description
`--changelog[=VERSION]`	Mostra o changelog. Use `--changelog` para obter a versão atual, `--changelog=all` para obter todas as versões ou `--changelog=x.x.x` para obter uma versão específica

q mcp

Gerencie servidores do protocolo de contexto para modelos (MCP). Para obter informações detalhadas sobre o MCP, consulte Usar o MCP com o Amazon Q Developer.

Sintaxe:


q mcp [SUBCOMMAND] [OPTIONS]

q mcp add

Adicione ou substitua um servidor MCP configurado.

Sintaxe:


q mcp add [OPTIONS]

Argumentos do q mcp add
Argumento	Description
`--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`	Substitui um servidor existente com o mesmo nome

q mcp remove

Remova um servidor da configuração do MCP.

Sintaxe:


q mcp remove [OPTIONS]

Argumentos do q mcp remove
Argumento	Description
`--name`	Nome do servidor a ser removido (obrigatório)
`--scope`	Escopo do qual remover. Opções:`workspace`, `global`

q mcp list

Liste os servidores MCP configurados.

Sintaxe:


q mcp list [SCOPE]

Argumentos do q mcp list
Argumento	Description
`SCOPE`	O escopo a ser listado. Opções: `workspace`, `global` (argumento posicional)

q mcp import

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

Sintaxe:


q mcp import [OPTIONS] [SCOPE]

Argumentos do q mcp import
Argumento	Description
`--file`	Arquivo do qual importar a configuração do servidor (obrigatório)
`--force`	Substitui um servidor existente com o mesmo nome
`SCOPE`	Escopo para o qual importar. Opções: `workspace`, `global` (argumento posicional)

q mcp status

Obter o status de um servidor MCP configurado.

Sintaxe:


q mcp status [OPTIONS]

Argumentos do q mcp status
Argumento	Description
`--name`	Nome do servidor do qual obter o status (obrigatório)

Arquivos de log

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

Locais de arquivos de log:

macOS: $TMPDIR/qlog/
Linux: $XDG_RUNTIME_DIR, TMPDIR ou /tmp

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

error: somente mensagens de erro (padrão)
warn: mensagens de erro e avisos
info: mensagens informativas, de aviso e erro
debug: mensagens informativas, de depuração, aviso e 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 logs sejam armazenados somente em sua máquina local e não sejam enviados à AWS, tenha cuidado ao compartilhar arquivos de log com outras pessoas.

Exemplo de configuração do nível de log (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

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Configurações relacionadas ao agente

Assistência da linha de comandos