Keyboard Shortcuts for Vim and Neovim
Augment flexibly integrates with your editor to provide keyboard shortcuts for common actions. Customize your keymappings to quickly accept suggestions and chat with Augment.
All available commands
Command | Action |
---|---|
:Augment enable | Globally enable suggestions (on by default) |
:Augment disable | Globally disable suggestions |
:Augment chat <message> | Send a chat message to Augment |
:Augment chat-new | Start a new chat conversation |
:Augment chat-toggle | Toggle the chat panel visibility |
:Augment signin | Start the sign in flow |
:Augment signout | Sign out of Augment |
:Augment status | View the current status of the plugin |
:Augment log | View the plugin log |
Creating custom shortcuts
You can create custom shortcuts for any of the above commands by adding mappings to your .vimrc
or init.lua
file. For example, to create a shortcut for the :Augment chat* commands, you can add the following mappings:
Customizing accepting a completion suggestion
By default Tab is used to accept a suggestion. If you want to use a key other than Tab to accept a suggestion, create a mapping that calls augment#Accept()
. The function takes an optional arugment used to specify the fallback text to insert if no suggestion is available.
You can disable the default Tab mapping by setting g:augment_disable_tab_mapping = v:true
before the plugin is loaded.