The main entrypoint to the Neovim gem. It allows you to connect to a running nvim instance programmatically or define a remote plugin to be autoloaded by nvim.

You can connect to a running nvim instance by setting or inspecting the NVIM_LISTEN_ADDRESS environment variable and connecting via the appropriate attach_ method. This is currently supported for both UNIX domain sockets and TCP. You can also spawn and connect to an nvim subprocess via +Neovim.attach_child(argv)+.

You can define a remote plugin using the +Neovim.plugin+ DSL, which allows you to register commands, functions, and autocmds. Plugins are autoloaded by nvim from the +rplugin/ruby+ directory in your nvim runtime path.

@example Connect over a TCP socket

  Neovim.attach_tcp("0.0.0.0", 3333) # => Neovim::Client

@example Connect over a UNIX domain socket

  Neovim.attach_unix("/tmp/nvim.sock") # => Neovim::Client

@example Spawn and connect to a child nvim process

  Neovim.attach_child(["nvim", "--embed"]) # => Neovim::Client

@example Define a Ruby plugin

  # ~/.config/nvim/rplugin/ruby/plugin.rb

  Neovim.plugin do |plug|
    # Define a command called "SetLine" which sets the contents of the
    # current line. This command is executed asynchronously, so the return
    # value is ignored.
    plug.command(:SetLine, :nargs => 1) do |nvim, str|
      nvim.current.line = str
    end

    # Define a function called "Sum" which adds two numbers. This function is
    # executed synchronously, so the result of the block will be returned to
    # nvim.
    plug.function(:Sum, :nargs => 2, :sync => true) do |nvim, x, y|
      x + y
    end

    # Define an autocmd for the BufEnter event on Ruby files.
    plug.autocmd(:BufEnter, :pattern => "*.rb") do |nvim|
      nvim.command("echom 'Ruby file, eh?'")
    end
  end

@see Client @see Plugin::DSL