32 KiB
Qwen Code 配置
Qwen Code 提供了多种方式来配置其行为,包括环境变量、命令行参数和设置文件。本文档概述了不同的配置方法和可用的设置项。
配置层级
配置按以下优先级顺序应用(数字越小优先级越低,会被数字越高的覆盖):
- 默认值: 应用程序内的硬编码默认值。
- 用户设置文件: 当前用户的全局设置。
- 项目设置文件: 项目特定的设置。
- 系统设置文件: 系统范围的设置。
- 环境变量: 系统范围或会话特定的变量,可能从
.env文件加载。 - 命令行参数: 启动 CLI 时传入的值。
配置文件
Qwen Code 使用 settings.json 文件进行持久化配置。这些文件有三个位置:
-
用户配置文件:
- 位置:
~/.qwen/settings.json(其中~是你的 home 目录)。 - 作用范围: 应用于当前用户的所有 Qwen Code 会话。
- 位置:
-
项目配置文件:
- 位置: 项目根目录下的
.qwen/settings.json。 - 作用范围: 仅在从该特定项目运行 Qwen Code 时应用。项目配置会覆盖用户配置。
- 位置: 项目根目录下的
-
系统配置文件:
- 位置:
/etc/qwen-code/settings.json(Linux)、C:\ProgramData\qwen-code\settings.json(Windows)或/Library/Application Support/QwenCode/settings.json(macOS)。可以通过QWEN_CODE_SYSTEM_SETTINGS_PATH环境变量覆盖路径。 - 作用范围: 应用于系统上所有用户的 Qwen Code 会话。系统配置会覆盖用户和项目配置。对于企业中的系统管理员来说,这可能有助于控制用户的 Qwen Code 设置。
- 位置:
关于配置中的环境变量说明: 在你的 settings.json 文件中,字符串值可以使用 $VAR_NAME 或 ${VAR_NAME} 语法引用环境变量。这些变量在加载配置时会自动解析。例如,如果你有一个环境变量 MY_API_TOKEN,你可以在 settings.json 中这样使用它:"apiKey": "$MY_API_TOKEN"。
项目中的 .qwen 目录
除了项目设置文件外,项目的 .qwen 目录还可以包含其他与 Qwen Code 运行相关的项目特定文件,例如:
- 自定义沙箱配置(例如,
.qwen/sandbox-macos-custom.sb、.qwen/sandbox.Dockerfile)。
settings.json 中可用的配置项:
-
contextFileName(字符串或字符串数组):- 说明: 指定上下文文件的文件名(例如
QWEN.md、AGENTS.md)。可以是单个文件名,也可以是多个可接受的文件名组成的数组。 - 默认值:
QWEN.md - 示例:
"contextFileName": "AGENTS.md"
- 说明: 指定上下文文件的文件名(例如
-
bugCommand(对象):- 说明: 覆盖
/bug命令的默认 URL。 - 默认值:
"urlTemplate": "https://github.com/QwenLM/qwen-code/issues/new?template=bug_report.yml&title={title}&info={info}" - 属性:
urlTemplate(字符串):一个可以包含{title}和{info}占位符的 URL。
- 示例:
"bugCommand": { "urlTemplate": "https://bug.example.com/new?title={title}&info={info}" }
- 说明: 覆盖
-
fileFiltering(对象):- 说明: 控制 @ 命令和文件发现工具的 git-aware 文件过滤行为。
- 默认值:
"respectGitIgnore": true, "enableRecursiveFileSearch": true - 属性:
respectGitIgnore(布尔值):在发现文件时是否遵循.gitignore的规则。设置为true时,被 git 忽略的文件(如node_modules/、dist/、.env)会自动从 @ 命令和文件列表操作中排除。enableRecursiveFileSearch(布尔值):在提示中补全 @ 前缀时,是否启用递归搜索当前目录树下的文件名。
- 示例:
"fileFiltering": { "respectGitIgnore": true, "enableRecursiveFileSearch": false }
-
coreTools(字符串数组):- 说明: 允许你指定一组核心工具名称,这些工具将对模型可用。可用于限制内置工具的使用范围。有关核心工具列表,请参见 Built-in Tools。你也可以为支持该功能的工具(如
ShellTool)指定命令级别的限制。例如,"coreTools": ["ShellTool(ls -l)"]将只允许执行ls -l命令。 - 默认值: 所有工具均可使用。
- 示例:
"coreTools": ["ReadFileTool", "GlobTool", "ShellTool(ls)"]
- 说明: 允许你指定一组核心工具名称,这些工具将对模型可用。可用于限制内置工具的使用范围。有关核心工具列表,请参见 Built-in Tools。你也可以为支持该功能的工具(如
-
excludeTools(字符串数组):- 说明: 允许你指定一组应从模型中排除的核心工具名称。如果某个工具同时出现在
excludeTools和coreTools中,则会被排除。你也可以为支持该功能的工具(如ShellTool)指定命令级别的限制。例如,"excludeTools": ["ShellTool(rm -rf)"]将阻止执行rm -rf命令。 - 默认值: 不排除任何工具。
- 示例:
"excludeTools": ["run_shell_command", "findFiles"] - 安全提示:
excludeTools中对run_shell_command的命令限制基于简单的字符串匹配,容易被绕过。此功能不是安全机制,不应依赖它来安全执行不受信任的代码。建议使用coreTools明确指定允许执行的命令。
- 说明: 允许你指定一组应从模型中排除的核心工具名称。如果某个工具同时出现在
-
allowMCPServers(字符串数组):- 说明: 允许你指定一组 MCP server 名称,这些 server 将对模型可用。可用于限制连接的 MCP server 范围。注意:如果设置了
--allowed-mcp-server-names,此配置将被忽略。 - 默认值: 所有 MCP server 均可用。
- 示例:
"allowMCPServers": ["myPythonServer"] - 安全提示: 此配置基于简单的字符串匹配,MCP server 名称可能被修改。如果你是系统管理员并希望防止用户绕过此限制,请考虑在系统级别配置
mcpServers,使用户无法自行配置 MCP server。此配置不应被视为严格的安全机制。
- 说明: 允许你指定一组 MCP server 名称,这些 server 将对模型可用。可用于限制连接的 MCP server 范围。注意:如果设置了
-
excludeMCPServers(字符串数组):- 说明: 允许你指定一组应从模型中排除的 MCP server 名称。如果某个 server 同时出现在
excludeMCPServers和allowMCPServers中,则会被排除。注意:如果设置了--allowed-mcp-server-names,此配置将被忽略。 - 默认值: 不排除任何 MCP server。
- 示例:
"excludeMCPServers": ["myNodeServer"] - 安全提示: 此配置基于简单的字符串匹配,MCP server 名称可能被修改。如果你是系统管理员并希望防止用户绕过此限制,请考虑在系统级别配置
mcpServers,使用户无法自行配置 MCP server。此配置不应被视为严格的安全机制。
- 说明: 允许你指定一组应从模型中排除的 MCP server 名称。如果某个 server 同时出现在
-
autoAccept(布尔值):- 说明: 控制 CLI 是否自动接受并执行被认为是安全的工具调用(例如只读操作),而无需用户明确确认。如果设置为
true,CLI 将跳过对安全工具的确认提示。 - 默认值:
false - 示例:
"autoAccept": true
- 说明: 控制 CLI 是否自动接受并执行被认为是安全的工具调用(例如只读操作),而无需用户明确确认。如果设置为
-
theme(字符串):- 说明: 设置 Qwen Code 的视觉 主题。
- 默认值:
"Default" - 示例:
"theme": "GitHub"
-
vimMode(布尔值):- 说明: 启用或禁用输入编辑的 vim 模式。启用后,输入区域支持 vim 风格的导航和编辑命令,包括 NORMAL 和 INSERT 模式。vim 模式状态会在页脚显示,并在会话间保持。
- 默认值:
false - 示例:
"vimMode": true
-
sandbox(布尔值或字符串):- 说明: 控制是否以及如何使用沙箱执行工具。如果设置为
true,Qwen Code 将使用预构建的qwen-code-sandboxDocker 镜像。更多信息请参见 Sandboxing。 - 默认值:
false - 示例:
"sandbox": "docker"
- 说明: 控制是否以及如何使用沙箱执行工具。如果设置为
-
toolDiscoveryCommand(字符串):- 说明: 定义一个自定义 shell 命令,用于从项目中发现工具。该 shell 命令必须在
stdout上返回一个 function declarations 的 JSON 数组。工具包装器是可选的。 - 默认值: 空
- 示例:
"toolDiscoveryCommand": "bin/get_tools"
- 说明: 定义一个自定义 shell 命令,用于从项目中发现工具。该 shell 命令必须在
-
toolCallCommand(字符串):- 说明: 定义一个自定义 shell 命令,用于调用通过
toolDiscoveryCommand发现的特定工具。该 shell 命令必须满足以下条件:- 必须将函数
name(与 function declaration 中完全一致)作为第一个命令行参数。 - 必须从
stdin读取 JSON 格式的函数参数,类似于functionCall.args。 - 必须在
stdout上返回 JSON 格式的函数输出,类似于functionResponse.response.content。
- 必须将函数
- 默认值: 空
- 示例:
"toolCallCommand": "bin/call_tool"
- 说明: 定义一个自定义 shell 命令,用于调用通过
-
mcpServers(对象):- 说明: 配置一个或多个 Model-Context Protocol (MCP) server 的连接,用于发现和使用自定义工具。Qwen Code 会尝试连接每个配置的 MCP server 以发现可用工具。如果多个 MCP server 提供同名工具,工具名称将加上你在配置中定义的 server 别名前缀(例如
serverAlias__actualToolName)以避免冲突。注意:系统可能会为了兼容性而从 MCP 工具定义中剥离某些 schema 属性。必须提供command、url或httpUrl中的至少一个。如果多个都指定,优先级顺序为httpUrl>url>command。 - 默认值: 空
- 属性:
<SERVER_NAME>(对象):指定 server 的参数。command(字符串,可选):通过标准 I/O 启动 MCP server 的命令。args(字符串数组,可选):传递给命令的参数。env(对象,可选):为 server 进程设置的环境变量。cwd(字符串,可选):启动 server 的工作目录。url(字符串,可选):使用 Server-Sent Events (SSE) 通信的 MCP server URL。httpUrl(字符串,可选):使用可流式 HTTP 通信的 MCP server URL。headers(对象,可选):发送到url或httpUrl的 HTTP headers。timeout(数字,可选):对此 MCP server 请求的超时时间(毫秒)。trust(布尔值,可选):信任此 server 并跳过所有工具调用确认。description(字符串,可选):server 的简要描述,可能用于显示。includeTools(字符串数组,可选):从此 MCP server 包含的工具名称列表。指定后,仅此列表中的工具可用(白名单行为)。未指定时,默认启用 server 的所有工具。excludeTools(字符串数组,可选):从此 MCP server 排除的工具名称列表。即使 server 提供这些工具,模型也无法使用。注意:excludeTools优先级高于includeTools—— 如果某个工具同时出现在两个列表中,它将被排除。
- 示例:
"mcpServers": { "myPythonServer": { "command": "python", "args": ["mcp_server.py", "--port", "8080"], "cwd": "./mcp_tools/python", "timeout": 5000, "includeTools": ["safe_tool", "file_reader"], }, "myNodeServer": { "command": "node", "args": ["mcp_server.js"], "cwd": "./mcp_tools/node", "excludeTools": ["dangerous_tool", "file_deleter"] }, "myDockerServer": { "command": "docker", "args": ["run", "-i", "--rm", "-e", "API_KEY", "ghcr.io/foo/bar"], "env": { "API_KEY": "$MY_API_TOKEN" } }, "mySseServer": { "url": "http://localhost:8081/events", "headers": { "Authorization": "Bearer $MY_SSE_TOKEN" }, "description": "An example SSE-based MCP server." }, "myStreamableHttpServer": { "httpUrl": "http://localhost:8082/stream", "headers": { "X-API-Key": "$MY_HTTP_API_KEY" }, "description": "An example Streamable HTTP-based MCP server." } }
- 说明: 配置一个或多个 Model-Context Protocol (MCP) server 的连接,用于发现和使用自定义工具。Qwen Code 会尝试连接每个配置的 MCP server 以发现可用工具。如果多个 MCP server 提供同名工具,工具名称将加上你在配置中定义的 server 别名前缀(例如
-
checkpointing(对象):- 说明: 配置 checkpointing 功能,允许你保存和恢复对话及文件状态。详情请参见 Checkpointing documentation。
- 默认值:
{"enabled": false} - 属性:
enabled(布尔值):当为true时,/restore命令可用。
-
preferredEditor(字符串):- 说明: 指定用于查看 diff 的首选编辑器。
- 默认值:
vscode - 示例:
"preferredEditor": "vscode"
-
telemetry(对象):- 说明: 配置 Qwen Code 的日志和指标收集。更多信息请参见 Telemetry。
- 默认值:
{"enabled": false, "target": "local", "otlpEndpoint": "http://localhost:4317", "logPrompts": true} - 属性:
enabled(布尔值):是否启用遥测。target(字符串):遥测数据的目标。支持的值为local和gcp。otlpEndpoint(字符串):OTLP Exporter 的 endpoint。logPrompts(布尔值):是否在日志中包含用户提示内容。
- 示例:
"telemetry": { "enabled": true, "target": "local", "otlpEndpoint": "http://localhost:16686", "logPrompts": false }
-
usageStatisticsEnabled(布尔值):- 说明: 启用或禁用使用统计信息的收集。更多信息请参见 Usage Statistics。
- 默认值:
true - 示例:
"usageStatisticsEnabled": false
-
hideTips(布尔值):- 说明: 启用或禁用 CLI 界面中的提示信息。
- 默认值:
false - 示例:
"hideTips": true
-
hideBanner(布尔值):- 说明: 启用或禁用 CLI 界面中的启动横幅(ASCII 艺术 logo)。
- 默认值:
false - 示例:
"hideBanner": true
-
maxSessionTurns(数字):- 说明: 设置会话的最大轮数。如果会话超过此限制,CLI 将停止处理并开始新对话。
- 默认值:
-1(无限制) - 示例:
"maxSessionTurns": 10
-
summarizeToolOutput(对象):- 说明: 启用或禁用工具输出的摘要功能。你可以使用
tokenBudget设置摘要的 token 预算。 - 注意:目前仅支持
run_shell_command工具。 - 默认值:
{}(默认禁用) - 示例:
"summarizeToolOutput": { "run_shell_command": { "tokenBudget": 2000 } }
- 说明: 启用或禁用工具输出的摘要功能。你可以使用
-
excludedProjectEnvVars(字符串数组):- 说明: 指定应从项目
.env文件中排除的环境变量。这可以防止项目特定的环境变量(如DEBUG=true)干扰 CLI 行为。.qwen/.env文件中的变量永远不会被排除。 - 默认值:
["DEBUG", "DEBUG_MODE"] - 示例:
"excludedProjectEnvVars": ["DEBUG", "DEBUG_MODE", "NODE_ENV"]
- 说明: 指定应从项目
-
includeDirectories(字符串数组):- 说明: 指定一组额外的绝对或相对路径,将其包含在工作区上下文中。这允许你跨多个目录操作文件,就像它们在一个目录中一样。路径可以使用
~表示用户主目录。此设置可以与--include-directories命令行标志结合使用。 - 默认值:
[] - 示例:
"includeDirectories": [ "/path/to/another/project", "../shared-library", "~/common-utils" ]
- 说明: 指定一组额外的绝对或相对路径,将其包含在工作区上下文中。这允许你跨多个目录操作文件,就像它们在一个目录中一样。路径可以使用
-
loadMemoryFromIncludeDirectories(布尔值):- 说明: 控制
/memory refresh命令的行为。如果设置为true,应从所有添加的目录中加载QWEN.md文件。如果设置为false,则只从当前目录加载QWEN.md。 - 默认值:
false - 示例:
"loadMemoryFromIncludeDirectories": true
- 说明: 控制
-
tavilyApiKey(字符串):- 说明: Tavily 网络搜索服务的 API key。启用
web_search工具功能时必需。如果未配置,网络搜索工具将被禁用并跳过。 - 默认值:
undefined(网络搜索禁用) - 示例:
"tavilyApiKey": "tvly-your-api-key-here"
- 说明: Tavily 网络搜索服务的 API key。启用
-
chatCompression(
示例 settings.json:
{
"theme": "GitHub",
"sandbox": "docker",
"toolDiscoveryCommand": "bin/get_tools",
"toolCallCommand": "bin/call_tool",
"tavilyApiKey": "$TAVILY_API_KEY",
"mcpServers": {
"mainServer": {
"command": "bin/mcp_server.py"
},
"anotherServer": {
"command": "node",
"args": ["mcp_server.js", "--verbose"]
}
},
"telemetry": {
"enabled": true,
"target": "local",
"otlpEndpoint": "http://localhost:4317",
"logPrompts": true
},
"usageStatisticsEnabled": true,
"hideTips": false,
"hideBanner": false,
"maxSessionTurns": 10,
"summarizeToolOutput": {
"run_shell_command": {
"tokenBudget": 100
}
},
"excludedProjectEnvVars": ["DEBUG", "DEBUG_MODE", "NODE_ENV"],
"includeDirectories": ["path/to/dir1", "~/path/to/dir2", "../path/to/dir3"],
"loadMemoryFromIncludeDirectories": true
}
Shell History
CLI 会保存你运行的 shell 命令历史记录。为了避免不同项目之间的冲突,这些历史记录会存储在用户主目录下的项目特定目录中。
- 位置:
~/.qwen/tmp/<project_hash>/shell_history<project_hash>是根据你的项目根路径生成的唯一标识符。- 历史记录存储在一个名为
shell_history的文件中。
环境变量 & .env 文件
环境变量是配置应用程序的常见方式,尤其适用于敏感信息(如 API keys)或在不同环境中可能变化的设置。关于认证配置,请参考 Authentication documentation,其中涵盖了所有可用的认证方法。
CLI 会自动从 .env 文件中加载环境变量。加载顺序如下:
- 当前工作目录中的
.env文件。 - 如果未找到,则向上级目录查找,直到找到
.env文件,或到达项目根目录(以.git文件夹为标识)或用户主目录。 - 如果仍未找到,则查找
~/.env(用户主目录下的.env文件)。
环境变量排除: 某些环境变量(如 DEBUG 和 DEBUG_MODE)默认会从项目 .env 文件中自动排除,以防止干扰 CLI 的行为。来自 .qwen/.env 文件的变量永远不会被排除。你可以通过在 settings.json 文件中配置 excludedProjectEnvVars 来自定义这一行为。
OPENAI_API_KEY:- 多种可用的 认证方法 之一。
- 可在 shell 配置文件(如
~/.bashrc、~/.zshrc)或.env文件中设置。
OPENAI_BASE_URL:- 多种可用的 认证方法 之一。
- 可在 shell 配置文件(如
~/.bashrc、~/.zshrc)或.env文件中设置。
OPENAI_MODEL:- 指定默认使用的 OPENAI 模型。
- 会覆盖硬编码的默认值。
- 示例:
export OPENAI_MODEL="qwen3-coder-plus"
GEMINI_SANDBOX:- 替代
settings.json中的sandbox设置。 - 可接受的值包括
true、false、docker、podman或自定义命令字符串。
- 替代
SEATBELT_PROFILE(仅 macOS):- 在 macOS 上切换 Seatbelt(
sandbox-exec)配置文件。 permissive-open:(默认)限制写入项目文件夹(及其他少数文件夹,详见packages/cli/src/utils/sandbox-macos-permissive-open.sb),但允许其他操作。strict:使用严格配置文件,默认拒绝所有操作。<profile_name>:使用自定义配置文件。要定义自定义配置文件,请在项目.qwen/目录下创建名为sandbox-macos-<profile_name>.sb的文件(例如my-project/.qwen/sandbox-macos-custom.sb)。
- 在 macOS 上切换 Seatbelt(
DEBUG或DEBUG_MODE(通常由底层库或 CLI 自身使用):- 设置为
true或1可启用详细调试日志,有助于排查问题。 - 注意: 这些变量默认会从项目
.env文件中自动排除,以防止干扰 CLI 行为。如需为 Qwen Code 特别设置这些变量,请使用.qwen/.env文件。
- 设置为
NO_COLOR:- 设置任意值可禁用 CLI 中的所有颜色输出。
CLI_TITLE:- 设置一个字符串来自定义 CLI 的标题。
CODE_ASSIST_ENDPOINT:- 指定代码辅助服务的 endpoint。
- 对开发和测试非常有用。
TAVILY_API_KEY:- 你的 Tavily 网络搜索服务的 API key。
- 启用
web_search工具功能所必需。 - 若未配置,网络搜索工具将被禁用并跳过。
- 示例:
export TAVILY_API_KEY="tvly-your-api-key-here"
命令行参数
在运行 CLI 时直接传入的参数可以覆盖该特定会话的其他配置。
--model <model_name>(-m <model_name>):- 指定本次会话使用的 Qwen 模型。
- 示例:
npm start -- --model qwen3-coder-plus
--prompt <your_prompt>(-p <your_prompt>):- 用于直接向命令传递 prompt。这将以非交互模式调用 Qwen Code。
--prompt-interactive <your_prompt>(-i <your_prompt>):- 使用提供的 prompt 作为初始输入启动交互式会话。
- prompt 会在交互式会话中处理,而不是在会话开始前处理。
- 当从 stdin 管道输入时不能使用。
- 示例:
qwen -i "explain this code"
--sandbox(-s):- 为本次会话启用 sandbox 模式。
--sandbox-image:- 设置 sandbox 镜像 URI。
--debug(-d):- 为本次会话启用 debug 模式,提供更详细的输出信息。
--all-files(-a):- 如果设置,则递归地将当前目录中的所有文件作为 prompt 的上下文包含进来。
--help(或-h):- 显示命令行参数的帮助信息。
--show-memory-usage:- 显示当前内存使用情况。
--yolo:- 启用 YOLO 模式,自动批准所有工具调用。
--approval-mode <mode>:- 设置工具调用的审批模式。可用模式包括:
default:对每个工具调用提示审批(默认行为)auto_edit:自动批准编辑类工具(edit、write_file),其他工具仍需提示审批yolo:自动批准所有工具调用(等同于--yolo)
- 不能与
--yolo同时使用。请使用--approval-mode=yolo替代--yolo,以采用新的统一方式。 - 示例:
qwen --approval-mode auto_edit
- 设置工具调用的审批模式。可用模式包括:
--telemetry:- 启用 telemetry。
--telemetry-target:- 设置 telemetry 目标。更多信息请参见 telemetry。
--telemetry-otlp-endpoint:- 设置 telemetry 的 OTLP endpoint。更多信息请参见 telemetry。
--telemetry-otlp-protocol:- 设置 telemetry 的 OTLP 协议(
grpc或http)。默认为grpc。更多信息请参见 telemetry。
- 设置 telemetry 的 OTLP 协议(
--telemetry-log-prompts:- 启用 telemetry 的 prompt 日志记录。更多信息请参见 telemetry。
--checkpointing:- 启用 checkpointing。
--extensions <extension_name ...>(-e <extension_name ...>):- 指定本次会话要使用的扩展列表。如果未提供,则使用所有可用扩展。
- 可使用特殊关键字
qwen -e none禁用所有扩展。 - 示例:
qwen -e my-extension -e my-other-extension
--list-extensions(-l):- 列出所有可用扩展并退出。
--proxy:- 设置 CLI 的代理。
- 示例:
--proxy http://localhost:7890。
--include-directories <dir1,dir2,...>:- 在工作区中包含额外目录,以支持多目录场景。
- 可多次指定或使用逗号分隔的值。
- 最多可添加 5 个目录。
- 示例:
--include-directories /path/to/project1,/path/to/project2或--include-directories /path/to/project1 --include-directories /path/to/project2
--version:- 显示 CLI 的版本。
--openai-logging:- 启用 OpenAI API 调用的日志记录,便于调试和分析。此标志会覆盖
settings.json中的enableOpenAILogging设置。
- 启用 OpenAI API 调用的日志记录,便于调试和分析。此标志会覆盖
--tavily-api-key <api_key>:- 为本次会话设置 Tavily API key,用于启用网页搜索功能。
- 示例:
qwen --tavily-api-key tvly-your-api-key-here
Context Files (分层指令上下文)
虽然严格来说不是 CLI 行为 的配置,但 context files(默认为 QWEN.md,可通过 contextFileName 设置项配置)对于配置 指令上下文(也称为 "memory")至关重要。这个强大的功能允许你向 AI 提供项目特定的指令、编码风格指南或任何相关的背景信息,从而使它的响应更贴合你的需求。CLI 包含 UI 元素,例如页脚中显示已加载 context files 数量的指示器,让你随时了解当前激活的上下文。
- 用途: 这些 Markdown 文件包含你希望 Qwen 模型在交互过程中了解的指令、指南或上下文信息。系统被设计为分层管理这些指令上下文。
示例上下文文件内容 (例如 QWEN.md)
以下是一个位于 TypeScript 项目根目录的上下文文件可能包含的内容概念示例:
# Project: My Awesome TypeScript Library
## General Instructions:
- When generating new TypeScript code, please follow the existing coding style.
- Ensure all new functions and classes have JSDoc comments.
- Prefer functional programming paradigms where appropriate.
- All code should be compatible with TypeScript 5.0 and Node.js 20+.
## Coding Style:
- Use 2 spaces for indentation.
- Interface names should be prefixed with `I` (e.g., `IUserService`).
- Private class members should be prefixed with an underscore (`_`).
- Always use strict equality (`===` and `!==`).
## Specific Component: `src/api/client.ts`
- This file handles all outbound API requests.
- When adding new API call functions, ensure they include robust error handling and logging.
- Use the existing `fetchWithRetry` utility for all GET requests.
## 关于依赖项:
- 除非绝对必要,否则应避免引入新的外部依赖项。
- 如果确实需要新的依赖项,请说明原因。
这个示例展示了如何提供通用的项目背景、特定的编码规范,甚至关于特定文件或组件的说明。你的上下文文件越相关且精确,AI 就越能更好地协助你。我们强烈建议创建项目特定的上下文文件,以建立约定和上下文环境。
- 分层加载与优先级: CLI 通过从多个位置加载上下文文件(例如
QWEN.md)实现了一套复杂的分层内存系统。列表中靠后的位置(更具体)的文件内容通常会覆盖或补充靠前位置(更通用)的文件内容。你可以使用/memory show命令查看确切的拼接顺序和最终上下文。典型的加载顺序如下:- 全局上下文文件:
- 位置:
~/.qwen/<contextFileName>(例如在你的用户主目录下的~/.qwen/QWEN.md)。 - 范围:为你的所有项目提供默认指令。
- 位置:
- 项目根目录及祖先目录的上下文文件:
- 位置:CLI 会在当前工作目录中查找配置的上下文文件,然后逐级向上搜索每个父目录,直到项目根目录(由
.git文件夹标识)或你的主目录为止。 - 范围:提供与整个项目或其重要部分相关的上下文。
- 位置:CLI 会在当前工作目录中查找配置的上下文文件,然后逐级向上搜索每个父目录,直到项目根目录(由
- 子目录上下文文件(局部/上下文相关):
- 位置:CLI 还会在当前工作目录 之下 的子目录中扫描配置的上下文文件(遵循如
node_modules、.git等常见的忽略模式)。默认情况下,此搜索范围限制为 200 个目录,但可以通过在settings.json文件中设置memoryDiscoveryMaxDirs字段进行配置。 - 范围:允许为项目中的特定组件、模块或子部分提供高度具体的指令。
- 位置:CLI 还会在当前工作目录 之下 的子目录中扫描配置的上下文文件(遵循如
- 全局上下文文件:
- 拼接与 UI 提示: 所有找到的上下文文件内容会被拼接在一起(使用分隔符标明其来源和路径),并作为系统提示的一部分提供给 AI。CLI 的页脚会显示已加载的上下文文件数量,让你快速了解当前激活的指令上下文。
- 导入内容: 你可以通过使用
@path/to/file.md语法导入其他 Markdown 文件来模块化你的上下文文件。更多详情请参阅 Memory Import Processor 文档。 - 内存管理命令:
- 使用
/memory refresh强制重新扫描并从所有配置的位置重新加载所有上下文文件。这将更新 AI 的指令上下文。 - 使用
/memory show显示当前加载的组合指令上下文,方便你验证 AI 正在使用的层级结构和内容。 - 有关
/memory命令及其子命令(show和refresh)的完整详情,请参阅 Commands 文档。
- 使用
通过理解并利用这些配置层级以及上下文文件的分层特性,你可以有效地管理 AI 的内存,并根据你的具体需求和项目定制 Qwen Code 的响应。
沙箱机制
Qwen Code 可以在沙箱环境中执行潜在的不安全操作(如 shell 命令和文件修改),以保护你的系统。
沙箱机制默认是关闭的,但你可以通过以下几种方式启用它:
- 使用
--sandbox或-s参数。 - 设置
GEMI_SANDBOX环境变量。 - 当使用
--yolo或--approval-mode=yolo时,沙箱机制会默认启用。
默认情况下,它会使用预构建的 qwen-code-sandbox Docker 镜像。
如果你的项目有特定的沙箱需求,可以在项目根目录下创建一个自定义的 Dockerfile,路径为 .qwen/sandbox.Dockerfile。这个 Dockerfile 可以基于基础沙箱镜像进行构建:
FROM qwen-code-sandbox
# 在这里添加你的自定义依赖或配置
# 例如:
# RUN apt-get update && apt-get install -y some-package
COPY ./my-config /app/my-config
当 `.qwen/sandbox.Dockerfile` 存在时,你可以在运行 Qwen Code 时使用 `BUILD_SANDBOX` 环境变量来自动构建自定义 sandbox 镜像:
```bash
BUILD_SANDBOX=1 qwen -s
使用统计
为了帮助我们改进 Qwen Code,我们会收集匿名化的使用统计数据。这些数据帮助我们了解 CLI 的使用情况、识别常见问题并优先开发新功能。
我们会收集的数据:
- 工具调用: 我们会记录被调用的工具名称、执行成功或失败的状态以及执行耗时。我们不会收集传递给工具的参数或工具返回的任何数据。
- API 请求: 我们会记录每次请求使用的模型、请求耗时以及请求是否成功。我们不会收集 prompt 或 response 的内容。
- 会话信息: 我们会收集 CLI 配置相关的信息,例如启用的工具和审批模式。
我们不会收集的数据:
- 个人身份信息 (PII): 我们不会收集任何个人信息,例如你的姓名、邮箱地址或 API key。
- Prompt 和 Response 内容: 我们不会记录你的 prompt 内容或模型返回的 response 内容。
- 文件内容: 我们不会记录 CLI 读取或写入的任何文件内容。
如何退出数据收集:
你可以随时通过在 settings.json 文件中将 usageStatisticsEnabled 属性设置为 false 来退出使用统计收集:
{
"usageStatisticsEnabled": false
}
注意:当启用使用统计时,事件会被发送到阿里云 RUM 收集端点。
enableWelcomeBack(boolean):- 说明: 当返回到有对话历史的项目时,显示欢迎回来对话框。
- 默认值:
true - 分类: UI
- 需要重启: 否
- 示例:
"enableWelcomeBack": false - 详情: 启用后,Qwen Code 会自动检测你是否返回到一个已有项目摘要(
.qwen/PROJECT_SUMMARY.md)的项目,并显示一个对话框,允许你继续之前的对话或重新开始。此功能与/chat summary命令和退出确认对话框集成。更多详情请参见 Welcome Back 文档。