配置 Amazon Q 设置 - Amazon Q 开发者版
访问设置通过命令行管理设置可用设置参考常用设置示例疑难解答设置其它 Amazon Q CLI 命令

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

配置 Amazon Q 设置

Amazon Q 提供了多种通过设置来自定义其行为的方法。您可以通过图形界面和命令行选项来访问这些设置。

访问设置

可以通过两种方式访问 Amazon Q 设置：

  • 设置 GUI：运行 q settings 以打开图形设置界面

  • 命令行：使用各种命令来直接查看和修改设置

通过命令行管理设置

可以使用以下命令从命令行中直接管理 Amazon Q 设置：

基本设置命令
命令 描述
q settings open 在默认编辑器中打开设置文件
q settings list 列出所有已配置的设置
q settings list --all 列出所有可用设置和说明
q settings list --format json-pretty 以格式化的 JSON 列出设置
q settings [KEY] 查看特定设置的值
q settings [KEY] [VALUE] 将特定设置设置为给定值
q settings --delete [KEY] 删除特定设置

使用 q settings 命令时，可以指定输出格式：

q settings --format [FORMAT]

可用的格式：

  • plain：将结果输出为纯文本（默认）

  • json：以 JSON 格式输出结果

  • json-pretty：将结果输出为格式化的 JSON

可用设置参考

以下各节介绍了按类别组织的所有可用的 Amazon Q CLI 设置。每个设置都包括其密钥名称、描述、预期值类型和示例。

遥测和隐私设置

遥测和隐私设置
设置密钥 描述 Type 示例
telemetry.enabled 启用/禁用遥测收集 布尔值 q settings telemetry.enabled true
telemetryClientId 用于遥测的旧版客户端标识符 字符串 q settings telemetryClientId "client-123"
codeWhisperer.shareCodeWhispererContentWithAWS 与 CodeWhisperer 服务共享内容 布尔值 q settings codeWhisperer.shareCodeWhispererContentWithAWS false

聊天界面设置

聊天界面设置
设置密钥 描述 Type 示例
chat.enableThinking 启用用于复杂推理的思维工具 布尔值 q settings chat.enableThinking true
chat.greeting.enabled 聊天开始时显示问候消息 布尔值 q settings chat.greeting.enabled false
chat.editMode 为聊天界面启用编辑模式 布尔值 q settings chat.editMode true
chat.enableNotifications 启用桌面通知 布尔值 q settings chat.enableNotifications true
chat.defaultModel 对话的默认 AI 模型 字符串 q settings chat.defaultModel "claude-3-sonnet"
chat.disableMarkdownRendering 在聊天中禁用 markdown 格式 布尔值 q settings chat.disableMarkdownRendering false
chat.defaultAgent 默认代理配置 字符串 q settings chat.defaultAgent "my-agent"
chat.disableAutoCompaction 禁用自动对话摘要 布尔值 q settings chat.disableAutoCompaction true
chat.enableHistoryHints 显示对话历史提示 布尔值 q settings chat.enableHistoryHints true
chat.uiMode 指定要使用的界面变体 字符串 q settings chat.uiMode "compact"
chat.enableContextUsageIndicator 在提示中显示上下文使用百分比 布尔值 q settings chat.enableContextUsageIndicator true

知识库设置

知识库设置
设置密钥 描述 Type 示例
chat.enableKnowledge 启用知识库功能 布尔值 q settings chat.enableKnowledge true
knowledge.defaultIncludePatterns 要包含在知识库中的默认文件模式 array q settings knowledge.defaultIncludePatterns '["*.py", "*.js"]'
knowledge.defaultExcludePatterns 要从知识库中排除的默认文件模式 array q settings knowledge.defaultExcludePatterns '["*.log", "node_modules"]'
knowledge.maxFiles 知识索引的最大文件数 数字 q settings knowledge.maxFiles 1000
knowledge.chunkSize 用于知识处理的文本块大小 数字 q settings knowledge.chunkSize 512
knowledge.chunkOverlap 文本块之间的重叠 数字 q settings knowledge.chunkOverlap 50
knowledge.indexType 要使用的知识索引类型 字符串 q settings knowledge.indexType "fast"

按键绑定

按键绑定设置
设置密钥 描述 Type 示例
chat.skimCommandKey 模糊搜索命令的按键绑定 char q settings chat.skimCommandKey "f"
chat.autocompletionKey 用于接受自动补全提示的按键绑定 char q settings chat.autocompletionKey "Tab"
chat.tangentModeKey 切线模式的按键绑定切换 char q settings chat.tangentModeKey "t"
chat.delegateModeKey 委托命令的按键绑定 char q settings chat.delegateModeKey "d"

功能切换

功能切换设置
设置密钥 描述 Type 示例
chat.enableTangentMode 启用切线模式功能 布尔值 q settings chat.enableTangentMode true
introspect.tangentMode 内省问题自动进入切线模式 布尔值 q settings introspect.tangentMode true
chat.enableTodoList 启用待办事项列表功能 布尔值 q settings chat.enableTodoList true
chat.enableCheckpoint 启用检查点功能 布尔值 q settings chat.enableCheckpoint true
chat.enableDelegate 为子代理管理启用委托工具 布尔值 q settings chat.enableDelegate true

API 和服务设置

API 和服务设置
设置密钥 描述 Type 示例
api.timeout API 请求超时（以秒为单位） 数字 q settings api.timeout 30
api.codewhisperer.service CodeWhisperer 服务端点 URL 字符串 q settings api.codewhisperer.service "https://codewhisperer.us-east-1.amazonaws.com"
api.q.service Q 服务端点 URL 字符串 q settings api.q.service "https://q.us-east-1.amazonaws.com"

模型上下文协议设置

MCP 设置
设置密钥 描述 Type 示例
mcp.initTimeout MCP 服务器初始化超时 数字 q settings mcp.initTimeout 10
mcp.noInteractiveTimeout 非交互式 MCP 超时 数字 q settings mcp.noInteractiveTimeout 5
mcp.loadedBefore 跟踪之前加载的 MCP 服务器 布尔值 q settings mcp.loadedBefore true

常用设置示例

以下是一些常见的配置场景：

基本配置

# Enable telemetry
q settings telemetry.enabled true

# Set default chat model
q settings chat.defaultModel "claude-3-sonnet"

# Disable greeting message
q settings chat.greeting.enabled false

知识库配置

# Enable knowledge base
q settings chat.enableKnowledge true

# Set file patterns to include
q settings knowledge.defaultIncludePatterns '["*.py", "*.js", "*.md", "*.txt"]'

# Set file patterns to exclude
q settings knowledge.defaultExcludePatterns '["*.log", "node_modules", ".git", "*.pyc"]'

# Set maximum files to index
q settings knowledge.maxFiles 2000

功能配置

# Enable experimental features
q settings chat.enableThinking true
q settings chat.enableTangentMode true
q settings chat.enableTodoList true
q settings chat.enableCheckpoint true

# Configure key bindings
q settings chat.tangentModeKey "t"
q settings chat.delegateModeKey "d"

查看和管理设置

# View all configured settings
q settings list

# View all available settings with descriptions
q settings list --all

# View specific setting
q settings chat.defaultModel

# Export settings as JSON
q settings list --format json-pretty > my-settings.json

# Delete a setting
q settings --delete chat.defaultModel

疑难解答设置

使用设置时的常见问题和解决方案：

设置值无效

如果您在设置值时遇到错误：

  • 布尔值：使用true或false（小写）

  • 数组值：使用带单引号的 JSON 格式：'["item1", "item2"]'

  • 字符串值：使用引号表示带空格的字符串："my value"

重置设置

要将设置重置为默认值：

# Delete individual settings
q settings --delete setting.name

# Open settings file for manual editing
q settings open

# View current settings to identify issues
q settings list --all

设置文件问题

如果设置文件损坏：

  1. 备份当前设置：q settings list --format json > backup.json

  2. 打开设置文件：q settings open

  3. 验证 JSON 语法或从备份中恢复

其它 Amazon Q CLI 命令

除了设置管理之外，Amazon Q 还提供许多其它命令行功能。有关所有可用命令及其参数的全面参考，请参阅 Amazon Q CLI 命令参考。

要获得任何命令的帮助，请使用 --help 标志：

q [COMMAND] --help