This plugin acts as a wrapper around the
distant binary. In order for this
plugin to function, you need to have the
distant binary installed on your
local machine and accessible from neovim.
Sound complicated? Not to worry! This plugin provides support to automatically install the binary for you and will automatically begin the dialog when you first attempt to invoke a command or function associated with the plugin.
If you already have the
distant binary (or
distant.exe on Windows)
accessible (i.e. on your path), then you can skip this installation
process! Just make sure that you have a version installed that is
compatible with the neovim plugin!
You can trigger the installation dialog manually by running
which will check if you have a copy of
distant available that is the correct
version. If the version is incompatible or no copy of
distant is found, a
dialog will trigger offering three choices:
- Download a prebuilt binary
- Build from source
- Copy local binary
Download a prebuilt binary
Selecting this option will query Github releases for compatible versions, downloading the release you select. The specific binary will be downloaded based on the detected operation system and architecture of your local machine.
For instance, an M1 Mac will download
distant-aarch64-apple-darwin whereas an
Intel-based Linux machine will download
downloaded binary will be renamed to work with this plugin.
This requires that your machine have
fetch installed and
available on your path.
|Dragonfly BSD||x86_64||(not yet supported)|
|NetBSD||x86_64||(not yet supported)|
|OpenBSD||x86_64||(not yet supported)|
Build from source
Selecting this option will download the latest copy of the distant repository from https://github.com/chipsenkbeil/distant.
Once downloaded, the source will be built using
cargo build --release and the
resulting binary will be copied into the appropriate location.
This requires that your machine have both
Additionally, due to the build requirements of distant's library, you will
perl to build a vendored copy of
Copy local binary
Selecting this option will prompt for the path to an executable to copy to the lua directory of this plugin.