Skip to content

Commit b906283

Browse files
committed
docs: add telemetryEnabled configuration option to both zh/en docs
1 parent 4cb25b3 commit b906283

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

docs/configuration.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Deep Code 使用 `settings.json` 设置文件进行持久化配置,支持两
3131
| `thinkingEnabled` | boolean | 是否启用思考模式(DeepSeek V4 系列默认启用) |
3232
| `reasoningEffort` | string | 推理强度,可选 `"high"``"max"`(默认 `"max"`|
3333
| `debugLogEnabled` | boolean | 是否启用调试日志输出(默认 `false`|
34+
| `telemetryEnabled` | boolean | 是否启用匿名使用数据上报(默认 `true`|
3435
| `notify` | string | 任务完成通知脚本的完整路径(如 Slack 通知脚本) |
3536
| `webSearchTool` | string | 自定义联网搜索脚本的完整路径 |
3637
| `mcpServers` | object | MCP 服务器配置(键为服务名,值为 McpServerConfig 对象) |
@@ -45,6 +46,7 @@ Deep Code 使用 `settings.json` 设置文件进行持久化配置,支持两
4546
| `THINKING_ENABLED` | string | 是否启用思考模式 |
4647
| `REASONING_EFFORT` | string | 推理强度 |
4748
| `DEBUG_LOG_ENABLED` | string | 是否启用调试日志输出 |
49+
| `TELEMETRY_ENABLED` | string | 是否启用匿名使用数据上报 |
4850
| `<其他任意KEY>` | string | 自定义环境变量 |
4951

5052
#### `thinkingEnabled` — 思考模式
@@ -130,6 +132,16 @@ MCP(Model Context Protocol)服务器配置。值是键值对,键为服务
130132

131133
设为 `true` 可让程序输出详细的调试日志(默认 `false`),用于排查 API 调用和工具执行的问题。
132134

135+
#### `telemetryEnabled` — 匿名使用数据上报
136+
137+
设为 `false` 可关闭匿名使用数据上报(默认 `true`)。上报仅包含匿名的机器标识,不包含对话内容、代码或 API 密钥。
138+
139+
也可以通过环境变量关闭:
140+
141+
```bash
142+
DEEPCODE_TELEMETRY_ENABLED=0 deepcode
143+
```
144+
133145
## 环境变量优先级
134146

135147
环境变量是配置应用程序的常用方式,尤其适用于敏感信息(如 api-key)或可能在不同环境之间更改的设置。

docs/configuration_en.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ The following are all the top-level fields supported in `settings.json`, along w
3131
| `thinkingEnabled` | boolean | Whether to enable thinking mode (enabled by default for DeepSeek V4 series)|
3232
| `reasoningEffort` | string | Reasoning intensity, either `"high"` or `"max"` (default `"max"`) |
3333
| `debugLogEnabled` | boolean | Enable debug log output (default `false`) |
34+
| `telemetryEnabled` | boolean | Enable anonymous usage reporting (default `true`) |
3435
| `notify` | string | Full path to a task-completion notification script (e.g., Slack notification script) |
3536
| `webSearchTool` | string | Full path to a custom web search script |
3637
| `mcpServers` | object | MCP server configurations (keys are service names, values are McpServerConfig objects) |
@@ -45,6 +46,7 @@ The following are all the top-level fields supported in `settings.json`, along w
4546
| `THINKING_ENABLED`| string | Enable thinking mode |
4647
| `REASONING_EFFORT`| string | Reasoning intensity |
4748
| `DEBUG_LOG_ENABLED`| string| Enable debug log output |
49+
| `TELEMETRY_ENABLED`| string| Enable anonymous usage reporting |
4850
| `<any other KEY>` | string | Custom environment variable |
4951

5052
#### `thinkingEnabled` — Thinking Mode
@@ -129,6 +131,16 @@ For detailed MCP usage instructions, refer to [mcp.md](mcp.md).
129131

130132
Set to `true` to enable detailed debug logging (default `false`), useful for troubleshooting API calls and tool execution.
131133

134+
#### `telemetryEnabled` — Anonymous Usage Reporting
135+
136+
Set to `false` to disable anonymous usage reporting (default `true`). The report only includes an anonymous machine identifier and does not contain conversation content, code, or API keys.
137+
138+
You can also disable it via environment variable:
139+
140+
```bash
141+
DEEPCODE_TELEMETRY_ENABLED=0 deepcode
142+
```
143+
132144
## Environment Variable Priority
133145

134146
Environment variables are a common way to configure applications, especially for sensitive information (such as api-key) or settings that may change between environments.

0 commit comments

Comments
 (0)