Getting Started

The easiest way to get started is to activate the built-in keybindings that come with Master Key.

1. Install this extension
2. On windows only: restart VSCode — there is an active investigation to avoid this workaround.
3. Run the command Master Key: Activate Keybindings
4. Select one of the built-in binding sets (e.g. "Simple Vim")
5. Review the binding set's documentation using Master Key: Show Text Documentation

Keybinding Customization

To start creating your own bindings:

1. Create a new a toml file
2. Optional: copy a preset into the file using Master key: New Keybinding Copy
3. Optional: import any existing user bindings, from keyindings.json, by calling Master Key: Import User Keybindings in this new toml file
4. Add/edit bindings, using the binding format and command documentation as a guide.
5. Activate the bindings with Master Key: Activate Keybindings at any time.

Roadmap

Master Key has reached a relatively stable state. There are no immediate plans to introduce major breaking changes. The major effort remaining is to improve the Vim bindings and create additional keybinding presets for Emacs and Helix.

Related Work

Master Key follows in the footsteps of many other extensions:

• VSCodeVim
• vscode-neovim
• Awesome Emacs Keymap
• Dance
• ModalEdit
• ModalKeys

And of course, there are many existing editors that Master Key draws inspiration from:

• vim
• emacs
• kakoune
• helix