Installation

Note: Neovide requires Neovim version 0.12+ including when using WSL or connecting to a remote Neovim server. If you need an older Neovim version, use an older Neovide release that supports it.

Building instructions are somewhat limited at the moment. All the libraries Neovide uses are cross platform and should have support for Windows, Mac, and Linux. The rendering is based on OpenGL, so a good GPU driver will be necessary, the default drivers provided by virtual machines might not be enough. On Windows this should be enabled by default if you have a relatively recent system.

Binaries

Installing should be as simple as downloading the binary, making sure the nvim executable with version 0.12+ is on your PATH environment variable, and running it. Everything should be self contained.

The binaries are to be found on the releases page where you can download:

Windows

Scoop

Scoop has Neovide in the extras bucket. Ensure you have the extras bucket, and install:

$ scoop bucket list
main
extras

$ scoop install neovide

Windows Source

Install the latest version of Rust. I recommend https://rustup.rs/
Install CMake. I use chocolatey: choco install cmake --installargs '"ADD_CMAKE_TO_PATH=System"' -y
Install LLVM. I use chocolatey: choco install llvm -y
Ensure graphics libraries are up to date.
Build and install Neovide:
```
cargo install --git https://github.com/neovide/neovide.git
```
The resulting binary can be found inside of ~/.cargo/bin afterwards (99% of the time).

Mac

Homebrew

Neovide is available as Cask in Homebrew. It can be installed from the command line:

brew install --cask neovide

If your shell cannot find neovide please follow homebrew post-installation steps. These add homebrew bin directory to your shell's PATH. Open a new terminal after updating your shell configuration.

If Neovide starts but cannot find nvim, check your login shell PATH. When launched from Finder or the Dock, Neovide starts Neovim through your login shell. Put homebrew shell setup in ~/.zprofile for Zsh or ~/.bash_profile for Bash. These files are read by login shells.

You can also set neovim-bin in Neovide configuration file to the absolute path of the Neovim executable. Run command -v nvim in a terminal where Neovim works to find that path. For example, with homebrew default installation on Apple Silicon:

neovim-bin = "/opt/homebrew/bin/nvim"

Mac Source

Install the latest version of Rust. Using homebrew: brew install rustup-init
Configure rust by running rustup-init
Install CMake. Using homebrew: brew install cmake
git clone https://github.com/neovide/neovide
cd neovide
cargo install --path .

The resulting binary is to be found under ~/.cargo/bin. In case you want a nice application bundle:
GENERATE_BUNDLE_APP=true GENERATE_DMG=true ./macos-builder/run
open ./target/release/bundle/osx/Neovide.dmg

Linux

Arch Linux

Stable releases are packaged in the extra repository.

pacman -S neovide

If you want to run Neovide on X11, you'll also need libxkbcommon-x11.

pacman -S libxkbcommon-x11

To run a development version you can build from the VCS package in the AUR. This can be built and installed using an AUR helper or by hand in the usual way. To build from a non-default branch you can edit the PKGBUILD and add #branch-name to the end of the source URL.

Nix

Stable releases are packaged in nixpkgs in the neovide package, there's no flake. As such, if you just want to try it out in a transient shell, you can use this command. Nixpkgs usually tracks stable builds; for nightly use the GitHub nightly artifacts or build from source.

Note: On non-NixOS systems, chances are you'll need to use nixGL as wrapper for neovide.

nix-shell -p neovide

NixOS

Just add neovide from nixpkgs to your environment.systemPackages in configuration.nix.

environment.systemPackages = with pkgs; [neovide];

Linux Source

Install necessary dependencies (adjust for your preferred package manager, probably most of this stuff is already installed, just try building and see)

Ubuntu/Debian

sudo apt install -y curl \
    gnupg ca-certificates git clang ninja-build \
    gcc-multilib g++-multilib cmake libssl-dev pkg-config \
    libfreetype6-dev libasound2-dev libexpat1-dev libxcb-composite0-dev \
    libbz2-dev libsndio-dev freeglut3-dev libxmu-dev libxi-dev libfontconfig1-dev \
    libxcursor-dev

Fedora

sudo dnf install clang ninja-build fontconfig-devel freetype-devel @development-tools \
    libstdc++-static libstdc++-devel

Arch

Do note that an AUR package already exists.

sudo pacman -S base-devel clang ninja fontconfig freetype2 libglvnd sndio cmake \
    git gtk3 python sdl2 vulkan-intel libxkbcommon-x11

Install Rust

curl --proto '=https' --tlsv1.2 -sSf "https://sh.rustup.rs" | sh

Fetch and build
```
cargo install --git https://github.com/neovide/neovide
```
The resulting binary can be found inside of ~/.cargo/bin afterwards, you might want to add this to your PATH environment variable.