Skip to content

Commit f2cd225

Browse files
committed
docs: add keybinds configuration reference (zh + en)
Document the keybinds settings field following the same format as enabledSkills and mcpServers: - Shortcut format: ctrl+key, ctrl+shift+key, meta+key - Project-over-user merge precedence - Runtime management via /keybind add|remove|list
1 parent 9e878ad commit f2cd225

2 files changed

Lines changed: 42 additions & 0 deletions

File tree

docs/configuration.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,27 @@ Deep Code 内置免费可用的 Web Search 工具。如果需要自定义搜索
120120
- 将某个 skill 设置为 `false` 后,所有项目级和用户级目录中解析名称相同的 skill 都会被隐藏。
121121
- 项目设置会按 skill 覆盖用户设置。如果项目设置没有配置某个 skill,则使用用户设置。
122122

123+
#### `keybinds` — 自定义快捷键
124+
125+
将键盘快捷键绑定到斜杠命令(如 `/exit``/new``/skills` 等)或 skill 名称,无需输入 `/` 即可触发操作。
126+
127+
```json
128+
{
129+
"keybinds": {
130+
"ctrl+e": "exit",
131+
"ctrl+n": "new",
132+
"ctrl+s": "skills",
133+
"ctrl+m": "model"
134+
}
135+
}
136+
```
137+
138+
- 快捷键格式:`ctrl+key``ctrl+shift+key``meta+key`(例如 `ctrl+e``ctrl+shift+i``meta+b`)。
139+
- 键名区分大小写匹配(`ctrl+e` 需按 `Ctrl+E`)。
140+
- 项目设置会按快捷键覆盖用户设置。如果项目设置中存在同名快捷键,则使用项目设置的值。
141+
- 自定义快捷键仅在无下拉菜单/弹窗打开时生效,以避免与菜单导航冲突。
142+
- 也可通过 `/keybind add|remove|list` 命令在运行时管理快捷键。
143+
123144
#### `mcpServers` — MCP 服务器
124145

125146
MCP(Model Context Protocol)服务器配置。值是键值对,键为服务名称,值为服务器配置对象。

docs/configuration_en.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,27 @@ Controls whether skills are included during skill scanning. Keys are resolved sk
120120
- Setting a skill to `false` hides every skill with that resolved `name`, across project and user skill roots.
121121
- Project settings override user settings per skill. If the project setting omits a skill, the user setting is used.
122122

123+
#### `keybinds` — Custom Keybinds
124+
125+
Bind keyboard shortcuts to slash commands (e.g. `/exit`, `/new`, `/skills`) or skill names, triggering actions without typing `/`.
126+
127+
```json
128+
{
129+
"keybinds": {
130+
"ctrl+e": "exit",
131+
"ctrl+n": "new",
132+
"ctrl+s": "skills",
133+
"ctrl+m": "model"
134+
}
135+
}
136+
```
137+
138+
- Shortcut format: `ctrl+key`, `ctrl+shift+key`, or `meta+key` (e.g. `ctrl+e`, `ctrl+shift+i`, `meta+b`).
139+
- Letter matching is case-insensitive (`ctrl+e` matches both `Ctrl+E` and `Ctrl+Shift+E` with exact modifier match).
140+
- Project settings override user settings per shortcut. If a shortcut exists in both, the project value wins.
141+
- Custom keybinds only fire when no dropdown/menu is open, to avoid conflicts with menu navigation.
142+
- You can also manage keybinds at runtime via `/keybind add|remove|list`.
143+
123144
#### `mcpServers` — MCP Servers
124145

125146
Configuration for MCP (Model Context Protocol) servers. The value is a key-value pair, where the key is the service name and the value is a server configuration object.

0 commit comments

Comments
 (0)