Repository files navigation

Documentation |Chat |Twitter

Neovim is a project that seeks to aggressively refactor Vim in order to:

• Simplify maintenance and encouragecontributions
• Split the work between multiple developers
• Enableadvanced UIs without modifications to the core
• Maximizeextensibility

See theIntroduction wiki page andRoadmapfor more information.

• ModernGUIs
• API accessfrom any language including C/C++, C#, Clojure, D, Elixir, Go, Haskell, Java,JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, Ruby, Rust
• Embedded, scriptableterminal emulator
• Asynchronousjob control
• Shared data (shada) among multiple editor instances
• XDG base directories support
• Compatible with most Vim plugins, including Ruby and Python plugins

See:help nvim-features for the full list!

Pre-built packages for Windows, macOS, and Linux are found on theReleases page.

Managed packages are inHomebrew,Debian,Ubuntu,Fedora,Arch Linux,Void Linux,Gentoo, and more!

See theBuilding Neovim wiki page for details.

The build is CMake-based, but a Makefile is provided as a convenience.After installing the dependencies, run the following command.

make CMAKE_BUILD_TYPE=RelWithDebInfosudo make install

To install to a non-default location:

make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/full/path/make install

CMake hints for inspecting the build:

• cmake --build build --target help lists all build targets.
• build/CMakeCache.txt (orcmake -LAH build/) contains the resolved values of all CMake variables.
• build/compile_commands.json shows the full compiler invocations for each translation unit.

See:help nvim-from-vim for instructions.

├─ ci/              build automation├─ cmake/           CMake utils├─ cmake.config/    CMake defines├─ cmake.deps/      subproject to fetch and build dependencies (optional)├─ runtime/         plugins and docs├─ src/nvim/        application source code (see src/nvim/README.md)│  ├─ api/          API subsystem│  ├─ eval/         VimL subsystem│  ├─ event/        event-loop subsystem│  ├─ generators/   code generation (pre-compilation)│  ├─ lib/          generic data structures│  ├─ lua/          Lua subsystem│  ├─ msgpack_rpc/  RPC subsystem│  ├─ os/           low-level platform code│  └─ tui/          built-in UI└─ test/            tests (see test/README.md)

Neovim contributions sinceb17d96 are licensed under theApache 2.0 license, except for contributions copied from Vim (identified by thevim-patch token). See LICENSE for details.

Vim is Charityware.  You can use and copy it as much as you like, but you areencouraged to make a donation for needy children in Uganda.  Please see thekcc section of the vim docs or visit the ICCF web site, available at these URLs:        http://iccf-holland.org/        http://www.vim.org/iccf/        http://www.iccf.nl/You can also sponsor the development of Vim.  Vim sponsors can vote forfeatures.  The money goes to Uganda anyway.