Neovim plugin for 🍃 Ethersync

Important

This plugin requires at least Neovim 0.7.0.

Installation

The Neovim plugin is located at https://github.com/ethersync/ethersync-nvim, so you would usually add the string "ethersync/ethersync-nvim" to your plugin manager. Here's some example configuration blocks:

Lazy

{
  "ethersync/ethersync-nvim",
  keys = { { "<leader>j", "<cmd>EthersyncJumpToCursor<cr>" } },
  lazy = false,
}

pckr.nvim

{
  "ethersync/ethersync-nvim",
  config = function()
    vim.keymap.set('n', '<leader>j', '<cmd>EthersyncJumpToCursor<cr>')
  end
}

Manual installation

If you're not using a plugin manager, here's a "quick and dirty" way to install the plugin:

git clone git@github.com:ethersync/ethersync-nvim $HOME/.local/share/nvim/site/pack/plugins/start/ethersync

Nix

For testing purposes, you can run an Ethersync-enabled Neovim like this:

nix run github:ethersync/ethersync#neovim

Confirm the installation

To confirm that the plugin is installed, try running the :EthersyncInfo command in Neovim. It should show the message "Not connected to Ethersync daemon."

Tips

We recommend creating a mapping for the :EthersyncJumpToCursor command (for example, <Leader>j, which jumps to another user's cursor.