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 the built-in binding set "Larkin"
5. Review Larkin's documentation (e.g. using Master Key: Show Text Documentation)

Keybinding Customization

There are two ways to start customizing bindings:

• Review the built-in Larkin presets: run the command Master key: New Keybinding Copy to start editing a copy of this preset. This is a toml file which has comments throughout.
• Review the binding file format and command documentation, and start creating your own TOML file.

The steps are:

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 bindings, as per the binding format and command documentation.
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 create additional keybinding presets for Emacs, Vim 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