Very experimental Neovim plugin providing partial Cursorless support. We support much of the core functionality, but many features are not yet implemented, in particular hats (#2567) and language-specific scopes (#2568). Expect some rough edges, but please give it a try, and if you like it, consider contributing!
- neovim (>= v0.10.0)
- Talon voice
- neovim-talon
- node/npm
- neovim node package (>= 5.1.0 installed globally)
- talon.nvim (likely required, unless standalone neovim GUI (nvim-qt.exe, neovide, etc)
Ideally, you want to use a neovim plugin manager like lazy.nvim.
After the typical lazy setup, you'll have to add the cursorless.nvim plugin to your init.lua.
require('lazy').setup({
'hands-free-vim/cursorless.nvim',
})This method is not recommended but you can try directly cloning the plugin into your nvim data folder:
git clone https://github.com/hands-free-vim/cursorless.nvim
If you aren't using a plugin manager that automatically calls setup for you (e.g. it is needed for lazy), you will need this somewhere in your neovim config, e.g. in init.lua:
require("cursorless").setup()Add a .talon file like the following anywhere in your Talon user directory (e.g. named cursorless_neovim.talon):
app: neovim
-
tag(): user.cursorlessBy default the keyboard shortcut used to communicate with cursorless is <C-S-f12>, but this might not work for
everybody and is configurable. You can change it by passing a different value in the configuration options passed to
setup():
require("cursorless").setup({ shortcut = `<C-Q>`})IMPORTANT: If you change this shortcut, be sure to set the corresponding neovim-talon setting. This can be done by
having a .talon file somewhere in your talon user directory that contains the following:
settings():
user.neovim_command_server_shortcut = "ctrl-q"You MUST currently use absolute row numbers in order to target rows using cursorless. The talon.nvim plugin will
configure this automatically, but your own config may be overriding it. Be sure to disable relative numbers.
Some Linux package managers ship with a version of nvim too old for Lazy. If this is the case, install nvim via another method.
If you are on Linux, avoid using the snap package for npm as it may not be able to globally expose the neovim npm package due to sandboxing. If this is the case, install node via another method (nvm, brew, etc).
Welcome! So glad you've decided to help make Cursorless in Neovim better.
Note that Cursorless is maintained as a monorepo, hosted at cursorless, and the source of truth for all of the files here lives there, so that's where you'll want to file a PR. We automatically deploy from our monorepo to the cursorless.nvim repo in CI.
See the Cursorless neovim contributor docs to get started.