Amazon Q CLI 命令参考
本节提供所有 Amazon Q 开发者版 CLI 命令及其参数的全面参考。使用此参考可了解每个命令的可用选项及其正确语法。
要获得任何命令的帮助，可以使用 --help 标志：
q [COMMAND] --help
全局参数
以下参数可用于任何 Amazon Q CLI 命令：
| 参数 | 简写形式 | 描述 |
|---|---|---|
--verbose
|
-v
|
增加日志记录详细程度。可以重复以获得更详细的输出：-v、-vv、-vvv、-vvvv |
--help
|
-h
|
显示命令的帮助信息。 |
--version
|
-V
|
显示版本信息 |
--help-all
|
打印所有子命令的帮助 |
命令
以下各节介绍每个 Amazon Q CLI 命令及其可用参数。
q chat
与 Amazon Q 开始交互式聊天会话。如果未指定子命令，则 q 默认为 q chat。
语法：
q chat [OPTIONS] [INPUT]
| 参数 | 简写形式 | 描述 |
|---|---|---|
--no-interactive
|
在不使用交互模式的情况下将第一个回复打印到 STDOUT。如果提示请求使用工具的权限，则此操作将失败，除非同时使用 --trust-all-tools |
|
--resume
|
-r
|
从此目录中恢复之前的对话 |
--agent
|
要使用的代理 | |
--trust-all-tools
|
支持模型在不要求确认的情况下使用任何工具来运行命令 | |
--trust-tools
|
仅信任指定的工具集。提供逗号分隔的工具名称列表。示例：--trust-tools=fs_read,fs_write。要不信任任何工具，请使用 --trust-tools= |
|
INPUT
|
要问的第一个问题（位置参数） |
示例：
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
使用 AI 将自然语言指令翻译成可执行的 Shell 命令。
语法：
q translate [OPTIONS] [INPUT...]
| 参数 | 简写形式 | 描述 |
|---|---|---|
--n
|
-n
|
要生成的完成次数（必须 ≤5） |
INPUT
|
要生成的命令的自然语言描述（位置参数） |
示例：
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
修复和诊断 Amazon Q 的常见安装和配置问题
语法：
q doctor [OPTIONS]
| 参数 | 简写形式 | 描述 |
|---|---|---|
--all
|
-a
|
运行所有医生检查，不修复 |
--strict
|
-s
|
警告时显示错误 |
示例：
q doctor q doctor --all q doctor --strict
q update
将 Amazon Q 应用程序更新为最新版本。
语法：
q update [OPTIONS]
| 参数 | 简写形式 | 描述 |
|---|---|---|
--non-interactive
|
-y
|
不提示进行确认 |
--relaunch-dashboard
|
更新后重新启动到控制面板。默认值为 true | |
--rollout
|
使用推出功能 |
示例：
q update q update --non-interactive q update --rollout
q theme
获取或设置自动完成下拉菜单的视觉主题。这会影响显示命令完成情况的弹出窗口的外观。
语法：
q theme [OPTIONS] [THEME]
| 参数 | 描述 |
|---|---|
--list
|
列出所有可用主题 |
--folder
|
显示主题目录路径 |
THEME
|
要设置的主题的名称。内置主题包括：dark、light、system（位置参数） |
示例：
q theme --list q theme --folder q theme dark q theme light q theme system
注意：主题更改会影响自动完成弹出窗口。您可能需要触发自动完成建议才能看到视觉变化。
q integrations
管理 Amazon Q 的系统集成。
语法：
q integrations [SUBCOMMAND] [OPTIONS]
q integrations 子命令
| 子命令 | 描述 |
|---|---|
install
|
安装集成。支持 --silent（-s）以禁止显示状态消息 |
uninstall
|
卸载集成。支持 --silent（-s）以禁止显示状态消息 |
reinstall
|
重新安装集成。支持 --silent（-s）以禁止显示状态消息 |
status
|
检查集成的状态。支持将 --format（-f）用于输出格式 |
q inline
管理在您键入时直接显示在命令行上的内联建议（虚影文本）。有关更多信息，请参阅 命令行辅助功能。
语法：
q inline [SUBCOMMAND] [OPTIONS]
q inline 子命令
| 子命令 | 描述 |
|---|---|
enable
|
启用在您键入时显示的内联建议 |
disable
|
禁用内联建议 |
status
|
显示是启用还是禁用内联建议 |
set-customization
|
选择要使用的自定义模型。（可选）指定自定义项的 ARN |
show-customizations
|
显示可用的自定义模型。支持将 --format（-f）用于输出格式 |
示例：
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
使用 AWS 构建者 ID（免费版）或 IAM Identity Center（专业套餐）向 Amazon Q 进行身份验证。
语法：
q login [OPTIONS]
| 参数 | 描述 |
|---|---|
--license
|
许可证类型。选项：free（对于构建者 ID）、pro（对于 Identity Center） |
--identity-provider
|
身份提供者 URL（对于 Identity Center） |
--region
|
AWS 区域（对于 Identity Center） |
--use-device-flow
|
始终使用 OAuth 设备流程进行身份验证。在无法处理浏览器重定向时很有用 |
示例：
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
退出 Amazon Q 会话。
语法：
q logout
此命令不带任何其它参数。
q whoami
显示有关当前用户和身份验证状态的信息。
语法：
q whoami [OPTIONS]
| 参数 | 简写形式 | 描述 |
|---|---|---|
--format
|
-f
|
输出格式。选项：plain（默认）、json、json-pretty |
q profile
显示与当前 IAM Identity Center 用户关联的配置文件。此命令仅适用于专业套餐用户。
语法：
q profile
此命令不带任何其它参数。
q settings
管理 Amazon Q 配置设置。有关设置管理的详细信息，请参阅配置 Amazon Q 设置。
语法：
q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
| 参数 | 简写形式 | 描述 |
|---|---|---|
--delete
|
-d
|
删除设置 |
--format
|
-f
|
输出格式。选项：plain（默认）、json、json-pretty |
KEY
|
设置键（位置参数） | |
VALUE
|
设置值（位置参数） |
q settings 子命令
| 子命令 | 描述 |
|---|---|
open
|
在默认编辑器中打开设置文件 |
all
|
列出所有当前设置。支持 --format 选项 |
q diagnostic
运行诊断测试以排查 Amazon Q 安装和配置问题。
语法：
q diagnostic [OPTIONS]
| 参数 | 简写形式 | 描述 |
|---|---|---|
--format
|
-f
|
输出格式。选项：plain（默认）、json、json-pretty |
--force
|
强制受限诊断输出 |
q issue
为 Amazon Q 反馈或错误报告创建一个新的 GitHub 问题。
语法：
q issue [OPTIONS] [DESCRIPTION...]
| 参数 | 简写形式 | 描述 |
|---|---|---|
--force
|
-f
|
强制创建问题 |
DESCRIPTION
|
问题描述（位置参数） |
q version
显示版本信息，也可以选择显示更改日志。
语法：
q version [OPTIONS]
| 参数 | 描述 |
|---|---|
--changelog[=VERSION]
|
显示更改日志。使用 --changelog 表示当前版本、使用 --changelog=all 表示所有版本或使用 --changelog=x.x.x 表示特定版本 |
q mcp
管理模型上下文协议（MCP）服务器。有关 MCP 的详细信息，请参阅将 MCP 与 Amazon Q 开发者版结合使用。
语法：
q mcp [SUBCOMMAND] [OPTIONS]
q mcp add
添加或替换已配置的 MCP 服务器。
语法：
q mcp add [OPTIONS]
| 参数 | 描述 |
|---|---|
--name
|
服务器的名称（必需） |
--command
|
用于启动服务器的命令（必需） |
--scope
|
添加服务器的位置。选项：workspace、global |
--env
|
启动服务器时要使用的环境变量。格式：key1=value1,key2=value2 |
--timeout
|
服务器启动超时（以毫秒为单位） |
--force
|
覆盖同名的现有服务器 |
q mcp remove
从 MCP 配置中移除服务器。
语法：
q mcp remove [OPTIONS]
| 参数 | 描述 |
|---|---|
--name
|
要移除的服务器的名称（必填） |
--scope
|
要从中移除的范围。选项：workspace、global |
q mcp list
列出已配置的 MCP 服务器。
语法：
q mcp list [SCOPE]
| 参数 | 描述 |
|---|---|
SCOPE
|
要列出的范围。选项：workspace、global（位置参数） |
q mcp import
从另一个文件导入服务器配置。
语法：
q mcp import [OPTIONS] [SCOPE]
| 参数 | 描述 |
|---|---|
--file
|
要从中导入服务器配置的文件（必需） |
--force
|
覆盖同名的现有服务器 |
SCOPE
|
要导入到的范围。选项：workspace、global（位置参数） |
q mcp status
获取已配置的 MCP 服务器的状态。
语法：
q mcp status [OPTIONS]
| 参数 | 描述 |
|---|---|
--name
|
要获取其状态的服务器的名称（必需） |
日志文件
Amazon Q 开发者版 CLI 维护的日志文件，可用于进行故障排除。这些日志本地存储在您的计算机上，不会发送到 AWS。
日志文件位置：
-
macOS：
$TMPDIR/qlog/ -
Linux：
$XDG_RUNTIME_DIR、TMPDIR或/tmp
可以通过设置 Q_LOG_LEVEL 环境变量来控制日志级别。有效值为：
-
error：仅限错误消息（默认） -
warn：警告和错误消息 -
info：信息、警告和错误消息 -
debug：调试、信息、警告和错误消息 -
trace：所有消息，包括详细的跟踪信息
警告
日志文件可能包含来自您与 Amazon Q 的对话和互动的敏感信息，包括文件路径、代码段和命令输出。虽然这些日志仅存储在本地计算机上，不会发送到 AWS，但在与他人共享日志文件时应谨慎行事。
设置日志级别的示例（用于调试目的）：
# For bash/zsh export Q_LOG_LEVEL=debug q chat # For fish set -x Q_LOG_LEVEL debug q chat
