直接编辑keybindings.json是唯一可靠方式,图形界面无法识别自定义工具命令,必须手动添加含key、command、when及args字段的JSON对象,command需精确匹配扩展ID,when表达式须与UI状态完全一致,args用于传递参数且格式必须正确。

直接编辑 keybindings.json 是唯一可靠方式
图形界面(Ctrl+K Ctrl+S)能快速绑定内置命令,但对自定义工具——比如你写的一个 Shell 脚本、用 terminal.runActiveFile 触发的 Python 工具、或通过扩展注册的自定义命令(如 myExtension.runLinter)——它往往无法识别或漏掉参数。这类命令不会出现在图形界面的默认搜索结果里,强行右键“添加键绑定”大概率失败或静默忽略。
真正起作用的方式只有一种:手动往 keybindings.json 里加对象。VSCode 启动时按顺序加载默认 → 扩展 → 用户配置,而用户级 keybindings.json 具有最高优先级,且支持完整语法(包括 when 和带参数的 command)。
- 按
Ctrl+Shift+P(Windows/Linux)或Cmd+Shift+P(macOS),输入Preferences: Open Keyboard Shortcuts (JSON)回车 - 确保文件以
[ ]开头和结尾,每条规则是数组中的一个对象 - 不要改
defaultKeybindings.json——它是只读的,改了也无效
command 字段必须精确匹配扩展暴露的 ID
很多自定义工具来自扩展,比如 Prettier、ESLint、或你自己写的 VS Code 插件。它们注册的命令名不是“看起来像就行”,而是严格区分大小写、连字符、命名空间的字符串。错一个字符,快捷键就完全不触发,且没有任何错误提示。
正确获取方式只有两个:
- 在图形界面中搜索该工具功能关键词(如 “prettier” 或 “lint”),找到对应条目后,把鼠标悬停上去,看 tooltip 里显示的完整
command值,例如prettier.executeFormat - 打开命令面板(
Ctrl+Shift+P),输入Developer: Inspect Context Keys,然后在你想触发工具的上下文(如打开一个 JS 文件并聚焦编辑器)中按一次你的目标快捷键,面板会显示当前所有生效的 context key 和已注册命令——这是最准的现场验证法
常见错误示例:"command": "prettier.format" ❌(实际是 prettier.executeFormat);"command": "runMyTool" ❌(实际可能是 mytool.run 或 extension.mytool.run)
when 条件写错 = 快捷键永远不响应
给自定义工具加快捷键,90% 的“失灵”问题出在 when 字段。它不是布尔开关,而是一个表达式字符串,必须与当前 UI 状态完全匹配才激活。比如你想让 ctrl+alt+b 只在 Markdown 文件里运行预览脚本,但写了 "when": "editorLangId == 'markdown'" ——看着对,其实错:VSCode 中 Markdown 的语言 ID 是 markdown,但某些扩展或旧版本可能返回 md,更稳妥的是用 editorLangId =~ /markdown|md/。
常用且可靠的 when 组合:
-
editorTextFocus && editorLangId == 'python':仅当光标在 Python 编辑器中 -
terminalFocus && terminalProcessSupported:仅终端聚焦且支持进程操作 -
resourceExtname == '.json' && !inDebugMode:仅 JSON 文件且非调试状态 - 多个条件必须用
&&连接,不能用空格或中文顿号;==和=~区分严格相等与正则匹配
调试技巧:在快捷键面板顶部搜索框里输入 @when: + 你的表达式(如 @when:editorLangId == 'python'),就能看到所有受该条件控制的快捷键,顺便验证它是否被识别。
带参数的命令必须用 args 字段封装
有些自定义工具需要传参才能工作,比如运行特定脚本路径、指定格式选项、或传入当前选中文本。VSCode 不支持在 key 或 command 字段里塞参数,必须用 args 字段显式声明。
例如,你想用 ctrl+alt+r 运行当前文件,但只在 Python 文件中调用 python -m mytool --fix:
[
{
"key": "ctrl+alt+r",
"command": "terminal.runActiveFile",
"when": "editorTextFocus && editorLangId == 'python'",
"args": {
"shellArgs": ["-m", "mytool", "--fix"]
}
}
]
注意点:
-
args是对象,不是字符串;不同命令接受的args结构差异极大(editor.action.insertSnippet要name,workbench.action.terminal.sendSequence要text) - 参数值里的反斜杠、引号要转义;路径建议用正斜杠(
/),跨平台兼容性更好 - 如果命令文档没写
args格式,去它的 GitHub repo 或package.json里的contributes.commands段找真实定义
最易被忽略的是:args 写错不会报错,只会让命令执行成空操作或默认行为——它比 command 名拼错更难排查。


















