Keyboard shortcuts for Visual Studio Code

Visual Studio Code lets you perform most tasks directly from the keyboard. This article explains how you can modify the default keyboard shorts that come with VS Code.

Keyboard Shortcuts editor

VS Code provides a rich keyboard shortcut editing experience with the Keyboard Shortcuts editor. The editor lists all available commands with and without keyboard shortcuts, and enables you to change, remove, or reset their keyboard shortcuts using the available actions. To find commands or keyboard shortcuts, use the search box and enter a command or shortcut to filter the list.

To open the Keyboard Shortcuts editor, select theFile >Preferences >Keyboard Shortcuts menu, or use thePreferences: Open Keyboard Shortcuts command (⌘K ⌘S (Windows, LinuxCtrl+K Ctrl+S)) in the Command Palette.

Customize shortcuts for UI actions

To customize a keyboard shortcut for a UI action, right-click on any action item in your workbench, and selectConfigure Keybinding. This opens the Keyboard Shortcuts editor, filtered to the corresponding command. If the action has awhen clause, it's automatically included, making it easier to set up your keyboard shortcuts just the way you need them.

Keymap extensions

Keymap extensions modify the VS Code shortcuts to match those of other editors, so you don't need to learn new keyboard shortcuts.

Select theFile >Preferences >Migrate Keyboard Shortcuts from... menu to get a list of popular keymap extensions. There is also aKeymaps category of extensions in the Marketplace.

Keyboard Shortcuts reference

We have a printable version of the default keyboard shortcuts. SelectHelp >Keyboard Shortcut Reference to display a condensed PDF version suitable for printing as an easy reference.

The following links provide access to the three platform-specific versions (US English keyboard):

• Windows
• macOS
• Linux

Detecting keyboard shortcut conflicts

If you have many extensions installed or you have modified your keyboard shortcuts, there might be keyboard shortcut conflicts, where the same keyboard shortcut is mapped to multiple commands. This can result in confusing behavior, especially if different keyboard shortcuts are going in and out of scope as you move around the editor.

Right-click on an item in the list of keyboard shortcuts, and selectShow Same Keybindings to view all entries with the same keyboard shortcut.

Troubleshooting keyboard shortcuts

To troubleshoot keyboard shortcut problems, you can execute the commandDeveloper: Toggle Keyboard Shortcuts Troubleshooting. This activates logging of dispatched keyboard shortcuts and opens the Output panel with the corresponding log file.

You can then press your desired keyboard shortcut and check what keyboard shortcut VS Code detects and what command is invoked.

For example, when pressingcmd+/ in a code editor on macOS, the logging output would be:

[KeybindingService]: / Received  keydown event - modifiers: [meta], code: MetaLeft, keyCode: 91, key: Meta[KeybindingService]: | Converted keydown event - modifiers: [meta], code: MetaLeft, keyCode: 57 ('Meta')[KeybindingService]: \ Keyboard event cannot be dispatched.[KeybindingService]: / Received  keydown event - modifiers: [meta], code: Slash, keyCode: 191, key: /[KeybindingService]: | Converted keydown event - modifiers: [meta], code: Slash, keyCode: 85 ('/')[KeybindingService]: | Resolving meta+[Slash][KeybindingService]: \ From 2 keybinding entries, matched editor.action.commentLine, when: editorTextFocus && !editorReadonly, source: built-in.

In the example log, the first keydown event is for theMetaLeft key (cmd) and cannot be dispatched. The second keydown event is for theSlash key (/) and is dispatched asmeta+[Slash]. There were two keyboard shortcut entries mapped frommeta+[Slash] and the one that matched was for the commandeditor.action.commentLine, which has thewhen conditioneditorTextFocus && !editorReadonly and is a built-in keyboard shortcut entry.

Viewing modified keyboard shortcuts

To filter the list to only show the shortcuts you have modified, select theShow User Keybindings command in theMore Actions (...) menu. This applies the@source:user filter to theKeyboard Shortcuts editor (Source is 'User').

Advanced customization

VS Code keeps track of the keyboard shortcuts you have customized in thekeybindings.json file. For advanced customization, you can also directly modify thekeybindings.json file.

To open thekeybindings.json file:

• OpenKeyboard Shortcuts editor, and then select theOpen Keyboard Shortcuts (JSON) button on the right of the editor title bar.

  

• Alternatively, use theOpen Default Keyboard Shortcuts (JSON) command in the Command Palette (⇧⌘P (Windows, LinuxCtrl+Shift+P)).

Keyboard rules

A keyboard shortcut configuration in VS Code is also known as akeyboard rule. Each rule consists of the following attributes:

• key: describes the pressed key(s), for example⌘F (Windows, LinuxCtrl+F).
• command: the identifier of the VS Code command to execute, for exampleworkbench.view.explorer to open the Explorer view.
• when: (optional) clause containing a boolean expression that is evaluated depending on the currentcontext.

Chords (two separate keypress actions) are described by separating the two keypresses with a space. For example,Ctrl+K Ctrl+C.

When a key is pressed, the following evaluation rules are applied:

• Rules are evaluated frombottom totop.
• The first rule that matches both thekey andwhen clause, is accepted.
• If a rule is found, no more rules are processed.
• If a rule is found and has acommand set, thecommand is executed.

The additionalkeybindings.json rules are appended at runtime to the bottom of the default rules, thus allowing them to overwrite the default rules. Thekeybindings.json file is watched by VS Code, so editing it while VS Code is running will update the rules at run-time.

The keyboard shortcuts dispatching is done by analyzing a list of rules that are expressed in JSON. Here are some examples:

// Keyboard shortcuts that are active when the focus is in the editor{"key":"home","command":"cursorHome","when":"editorTextFocus" },{"key":"shift+home","command":"cursorHomeSelect","when":"editorTextFocus" },// Keyboard shortcuts that are complementary{"key":"f5","command":"workbench.action.debug.continue","when":"inDebugMode" },{"key":"f5","command":"workbench.action.debug.start","when":"!inDebugMode" },// Global keyboard shortcuts{"key":"ctrl+f","command":"actions.find" },{"key":"alt+left","command":"workbench.action.navigateBack" },{"key":"alt+right","command":"workbench.action.navigateForward" },// Global keyboard shortcuts using chords (two separate keypress actions){"key":"ctrl+k enter","command":"workbench.action.keepEditor" },{"key":"ctrl+k ctrl+w","command":"workbench.action.closeAllEditors" },

Accepted keys

Thekey is made up of modifiers and the key itself.

The following modifiers are accepted:

The following keys are accepted:

• f1-f19,a-z,0-9
• `,-,=,[,],\,;,',,,.,/
• left,up,right,down,pageup,pagedown,end,home
• tab,enter,escape,space,backspace,delete
• pausebreak,capslock,insert
• numpad0-numpad9,numpad_multiply,numpad_add,numpad_separator
• numpad_subtract,numpad_decimal,numpad_divide

Command arguments

You can invoke a command with arguments. This is useful if you often perform the same operation on a specific file or folder. You can add a custom keyboard shortcut to do exactly what you want.

The following is an example overriding theEnter key to print some text:

{  "key":"enter",  "command":"type",  "args": {"text":"Hello World" },  "when":"editorTextFocus"}

Thetype command will receive{"text": "Hello World"} as its first argument, and add "Hello World" to the file instead of producing the default command.

For more information on commands that take arguments, refer toBuilt-in Commands.

Running multiple commands

A keyboard shortcut can be configured to run multiple commands sequentially by using the commandrunCommands.

• Run several commands without arguments:

  The following example copies the current line down, marks the current line as a comment, and moves the cursor to the copied line.

  {  "key":"ctrl+alt+c",  "command":"runCommands",  "args": {    "commands": [      "editor.action.copyLinesDownAction",      "cursorUp",      "editor.action.addCommentLine",      "cursorDown"    ]  }},

• To pass arguments to commands:

  This example creates a new untitled TypeScript file and inserts a custom snippet.

  {  "key":"ctrl+n",  "command":"runCommands",  "args": {    "commands": [      {        "command":"workbench.action.files.newUntitledFile",        "args": {          "languageId":"typescript"        }      },      {        "command":"editor.action.insertSnippet",        "args": {          "langId":"typescript",          "snippet":"class ${1:ClassName} {\n\tconstructor() {\n\t\t$0\n\t}\n}"        }      }    ]  }},

Note that commands run byrunCommands receive the value of"args" as the first argument. In the previous example,workbench.action.files.newUntitledFile receives{"languageId": "typescript" } as its first and only argument.

To pass several arguments, you need to have"args" as an array:

{  "key":"ctrl+shift+e",  "command":"runCommands",  "args": {    "commands": [      {        // command invoked with 2 arguments: vscode.executeCommand("myCommand", "arg1", "arg2")        "command":"myCommand",        "args": ["arg1","arg2"]      }    ]  }}

To pass an array as the first argument, wrap the array in another array:"args": [ [1, 2, 3] ].

Removing a keyboard shortcut

To remove a keyboard shortcut, right-click on the entry in the Keyboard Shortcuts editor, and selectRemove Keybinding.

To remove a keyboard shortcut by using thekeybindings.json file, add a- to thecommand and the rule will be a removal rule.

Here is an example:

// In Default Keyboard Shortcuts...{"key":"tab","command":"tab","when":... },{"key":"tab","command":"jumpToNextSnippetPlaceholder","when":... },{"key":"tab","command":"acceptSelectedSuggestion","when":... },...// To remove the second rule, for example, add in keybindings.json:{"key":"tab","command":"-jumpToNextSnippetPlaceholder" }

To override a specific keyboard shortcut rule with an empty action, you can specify an empty command:

// To override and disable any `tab` keyboard shortcut, for example, add in keybindings.json:{"key":"tab","command":"" }

Keyboard layouts

Keys are string representations for virtual keys and do not necessarily relate to the produced character when they are pressed. More precisely:

• Reference:Virtual-Key Codes (Windows)
• tab forVK_TAB (0x09)
• ; forVK_OEM_1 (0xBA)
• = forVK_OEM_PLUS (0xBB)
• , forVK_OEM_COMMA (0xBC)
• - forVK_OEM_MINUS (0xBD)
• . forVK_OEM_PERIOD (0xBE)
• / forVK_OEM_2 (0xBF)
• ` forVK_OEM_3 (0xC0)
• [ forVK_OEM_4 (0xDB)
• \ forVK_OEM_5 (0xDC)
• ] forVK_OEM_6 (0xDD)
• ' forVK_OEM_7 (0xDE)
• etc.

Different keyboard layouts usually reposition these virtual keys or change the characters produced when they are pressed. When using a different keyboard layout than the standard US, Visual Studio Code does the following:

All the keyboard shortcuts are rendered in the UI using the current system's keyboard layout. For example,Split Editor when using a French (France) keyboard layout is now rendered asCtrl+*:

When editingkeybindings.json, VS Code highlights misleading keyboard shortcuts, those that are represented in the file with the character produced under the standard US keyboard layout, but that need pressing keys with different labels under the current system's keyboard layout. For example, here is how the default keyboard shortcut rules look like when using a French (France) keyboard layout:

There is also a UI control that helps input the keyboard shortcut rule when editingkeybindings.json. To launch theDefine Keybinding control, press⌘K ⌘K (Windows, LinuxCtrl+K Ctrl+K). The control listens for key presses and renders the serialized JSON representation in the text box and below it, the keys that VS Code has detected under your current keyboard layout. Once you've typed the key combination you want, you can pressEnter and a rule snippet is inserted.

Keyboard layout-independent bindings

Using scan codes, it is possible to define keyboard shortcuts that do not change with the change of the keyboard layout. For example:

{"key":"cmd+[Slash]","command":"editor.action.commentLine","when":"editorTextFocus" }

Accepted scan codes:

• [F1]-[F19],[KeyA]-[KeyZ],[Digit0]-[Digit9]
• [Backquote],[Minus],[Equal],[BracketLeft],[BracketRight],[Backslash],[Semicolon],[Quote],[Comma],[Period],[Slash]
• [ArrowLeft],[ArrowUp],[ArrowRight],[ArrowDown],[PageUp],[PageDown],[End],[Home]
• [Tab],[Enter],[Escape],[Space],[Backspace],[Delete]
• [Pause],[CapsLock],[Insert]
• [Numpad0]-[Numpad9],[NumpadMultiply],[NumpadAdd],[NumpadComma]
• [NumpadSubtract],[NumpadDecimal],[NumpadDivide]

when clause contexts

VS Code gives you precise control over when your keyboard shortcuts are enabled through the optionalwhen clause. If your keyboard shortcut doesn't have awhen clause, the keyboard shortcut is globally available at all times. Awhen clause evaluates to either true or false for enabling keyboard shortcuts.

VS Code sets various context keys and specific values depending on what elements are visible and active in the VS Code UI. For example, the built-inStart Debugging command has the keyboard shortcutF5, which is only enabled when there is an appropriate debugger available (contextdebuggersAvailable is true) and the editor isn't in debug mode (contextinDebugMode is false):

You can also view a keyboard shortcut's when clause directly in the defaultkeybinding.json (Preferences: Open Default Keyboard Shortcuts (JSON)):

{"key":"f5","command":"workbench.action.debug.start",                   "when":"debuggersAvailable && !inDebugMode" },

Conditional operators

Forwhen clause conditional expressions, the following conditional operators are useful for keyboard shortcuts:

You can find the full list of when clause conditional operators in thewhen clause contexts reference.

Available contexts

You can find some of the availablewhen clause contexts in thewhen clause context reference.

The list there isn't exhaustive and you can find otherwhen clause contexts by searching and filtering in the Keyboard Shortcuts editor (Preferences: Open Keyboard Shortcuts ) or reviewing the defaultkeybindings.json file (Preferences: Open Default Keyboard Shortcuts (JSON)).

Custom keyboard shortcuts for refactorings

Theeditor.action.codeAction command lets you configure keyboard shortcuts for specificRefactorings (Code Actions). For example, the keyboard shortcut below triggers theExtract function refactoring Code Action:

{  "key":"ctrl+shift+r ctrl+e",  "command":"editor.action.codeAction",  "args": {    "kind":"refactor.extract.function"  }}

This is covered in depth in theRefactoring article, where you can learn about different kinds of Code Actions and how to prioritize them in the case of multiple possible refactorings.

Related resources

• VS Code default keyboard shortcuts reference

Common questions

How can I find out what command is bound to a specific key?

In the Keyboard Shortcuts editor, you can filter on specific keystrokes to see which commands are bound to which keys. In the following screenshot, you can see thatCtrl+Shift+P is bound toShow All Commands to bring up the Command Palette.

How to add a keyboard shortcut to an action, for example, add Ctrl+D to Delete Lines

Find a rule that triggers the action in theDefault Keyboard Shortcuts and write a modified version of it in yourkeybindings.json file:

// Original, in Default Keyboard Shortcuts{"key":"ctrl+shift+k","command":"editor.action.deleteLines",                                     "when":"editorTextFocus" },// Modified, in User/keybindings.json, Ctrl+D now will also trigger this action{"key":"ctrl+d","command":"editor.action.deleteLines",                                     "when":"editorTextFocus" },

How can I add a keyboard shortcut for only certain file types?

Use theeditorLangId context key in yourwhen clause:

{"key":"shift+alt+a","command":"editor.action.blockComment",                                     "when":"editorTextFocus && editorLangId == csharp" },

I have modified my keyboard shortcuts inkeybindings.json; why don't they work?

The most common problem is a syntax error in the file. Otherwise, try removing thewhen clause or picking a differentkey. Unfortunately, at this point, it is a trial and error process.