You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README-en.md
+23-94Lines changed: 23 additions & 94 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,129 +103,58 @@ Yes. Deep Code offers a full-featured VSCode extension, available on the [VSCode
103
103
104
104
Deep Code supports multimodal input — you can paste images from the clipboard with `Ctrl+V`. However, `deepseek-v4` does not support multimodal yet. Some models have multimodal capabilities but impose strict limits on multi-turn dialogue requests. For multimodal input, we recommend using the Volcano Ark `Doubao-Seed-2.0-pro` model, which has the best integration.
105
105
106
-
### How to automatically send a Slack message after a task completes?
106
+
### How to send a Slack message after a task completes?
107
107
108
-
Write a shell notification script that calls a Slack webhook, then set the `notify` field in `~/.deepcode/settings.json` to the full path of the script. For detailed steps, see [docs/notify_en.md](docs/notify_en.md).
108
+
Write a shell notification script that calls a Slack webhook, then set the `notify` field in `~/.deepcode/settings.json` to the full path of the script.
109
109
110
-
### How do I enable web search?
111
-
112
-
Deep Code comes with a built-in, free Web Search tool that works well for most use cases. If you prefer to use a custom script for web search, set the `webSearchTool` field in `~/.deepcode/settings.json` to the full path of your script. For detailed steps, refer to: https://github.com/qorzj/web_search_cli
110
+
> 📖 See [docs/notify_en.md](docs/notify_en.md) for details.
113
111
114
-
### Does it support Coding Plan?
112
+
### How do I enable web search?
115
113
116
-
Yes. Just set `env.BASE_URL` in `~/.deepcode/settings.json` to an OpenAI-compatible API endpoint. Take Volcano Ark's Coding Plan as an example:
Deep Code comes with a built-in, free Web Search tool that works well for most use cases. If you prefer to use a custom script for web search, set the `webSearchTool` field in `~/.deepcode/settings.json` to the full path of your script. For details, refer to: https://github.com/qorzj/web_search_cli
128
115
129
116
### How do I configure MCP?
130
117
131
118
Deep Code supports MCP (Model Context Protocol) to connect external services such as GitHub, browsers, databases, and more. Configure the `mcpServers` field in `settings.json` to enable it, then use the `/mcp` command to view MCP server status and available tools.
132
119
133
-
For detailed setup instructions, see: [docs/mcp.md](docs/mcp.md)
120
+
> 📖 See [docs/mcp.md](docs/mcp.md) for details.
134
121
135
-
### How to configure Deep Code to send notifications after a task completes?
122
+
### How to configure notifications after a task completes?
136
123
137
-
When the AI assistant completes a task, Deep Code can automatically execute a notification script to send the task results to the specified channel (e.g., Slack, system notifications, etc.).
124
+
When the AI assistant completes a task, Deep Code can automatically execute a notification script to send the results to your specified channel (e.g., Slack, system notifications, etc.).
138
125
139
-
For detailed configuration instructions, see: [docs/notify_en.md](docs/notify_en.md)
126
+
> 📖 See [docs/notify_en.md](docs/notify_en.md) for details.
140
127
141
128
### Does Deep Code only support YOLO mode?
142
129
143
130
No. Deep Code has a built-in fine-grained permission control mechanism that lets you confirm operations before the AI assistant executes shell commands, reads/writes files, accesses the network, and more. You can configure each permission scope's policy — always allow, always ask, or deny — via the `permissions` field in `settings.json`. See [docs/permission.md](docs/permission.md) for details.
144
131
145
-
### How do I customize the theme?
146
-
147
-
Deep Code CLI includes multiple built-in preset themes, defaulting to the light theme (`light`). You can switch presets by setting `theme.preset` in `settings.json`, or set it to `"custom"` for full customization.
148
-
149
-
**Using preset themes**
150
-
151
-
Set `theme.preset` in `settings.json` to switch:
152
-
153
-
```json
154
-
{
155
-
"theme": {
156
-
"preset": "dark"
157
-
}
158
-
}
159
-
```
160
-
161
-
Available presets: `light` (default), `dark`, `github-light`, `github-dark`, `monokai`, `dracula`, `ansi`.
162
-
163
-
You can also use the `/theme` command at runtime to open the theme picker with live preview.
**Option 2: Full customization (preset="custom" + tokens)**
182
-
183
-
Provide a complete tokens object, merged on top of the light theme:
184
-
185
-
```json
186
-
{
187
-
"theme": {
188
-
"preset": "custom",
189
-
"tokens": {
190
-
"primary": "#229ac3",
191
-
"secondary": "#229ac3e6",
192
-
"success": "green",
193
-
"error": "red",
194
-
"warning": "yellow",
195
-
"info": "magenta",
196
-
"text": "white",
197
-
"textDim": "gray",
198
-
"textBright": "white",
199
-
"code": "cyan",
200
-
"border": "gray",
201
-
"gradients": ["#229ac3e6", "#229ac3e6"]
202
-
}
203
-
}
204
-
}
205
-
```
147
+
### How to use and customize themes?
206
148
207
-
> Note: `overrides` and `tokens` only take effect when `preset` is set to `"custom"`. When `preset` is unset, the `light` theme is used by default.
149
+
Deep Code CLI includes 8 built-in preset themes, supports the `/theme` command for live preview and switching, and allows full customization via `settings.json`.
208
150
209
-
Default light theme (`light`) color values:
151
+
**Quick switch:** Run `/theme` to open the picker. Browse with arrow keys, confirm with Enter, cancel with Esc.
210
152
211
-
| Token | Default | Used For |
212
-
|-------|---------|----------|
213
-
|`primary`|`#229ac3`| Primary brand: user messages, selected items, status line bullets, Markdown headings |
Color values support hex (`"#ff6600"`), hex with alpha (`"#229ac3e6"`), and chalk named colors (`"cyanBright"`, `"green"`).
155
+
**Custom themes:** Supports simplified color palette (`colors`), partial overrides (`overrides`), and full customization (`tokens`).
227
156
228
-
> Note: `tokens` takes priority over `overrides` — if both are specified, only `tokens` is used. Theme settings can be placed in the global `~/.deepcode/settings.json` or the project-root `.deepcode/settings.json`.
157
+
> 📖 See [docs/configuration.md](docs/configuration.md) for the full configuration guide.
0 commit comments