mirror of
https://github.com/neovim/neovim.git
synced 2026-08-03 06:09:14 +00:00
8f1bd935cb
vim-patch:8.2.4761: documentation for using LSP messages is incomplete vim-patch:8.2.4780: parsing an LSP message fails when it is split vim-patch:9.0.0979: ch_log() text can be hard to find in the log file vim-patch:1a946044f runtime(doc): correct return types for job_start() and job_status() vim-patch:1cd31a450 runtime(doc): update return type for job_info() vim-patch:15141208e runtime(doc): -x is only available when compiled with crypt feature vim-patch:a37fd7274 runtime(doc): Remove accidental option name highlighting from :help channel.txt vim-patch:9.2.0021: channel: connection timeout fails to fall back to IPv4 vim-patch:9.2.0314: channel: can bind to all network interfaces vim-patch:9.2.0317: listener functions do not check secure flag vim-patch:60e925ca0 runtime(doc): Tweak documentation style in channel.txt vim-patch:9.2.0843: [security]: popup: opacity mask indexed out of bounds vim-patch:9.2.0844: [security]: use-after-free on json decode error vim-patch:9.2.0847: [security]: vimball: code execution via .VimballRecord file vim-patch:b0e6baab8 Update .gitignore and .hgignore files vim-patch:9.2.0851: Focus autocommands triggered inconsistently vim-patch:9.2.0852: GTK: ligatures not correctly displayed vim-patch:9.2.0853: popup: popup images do not support scaling
Neovim is a project that seeks to aggressively refactor Vim in order to:
- Simplify maintenance and encourage contributions
- Split the work between multiple developers
- Enable advanced UIs without modifications to the core
- Maximize extensibility
See the Introduction wiki page and Roadmap for more information.
Features
- Modern GUIs
- API access from any language including C/C++, C#, Clojure, D, Elixir, Go, Haskell, Java/Kotlin, JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, Ruby, Rust
- Embedded, scriptable terminal emulator
- Asynchronous job 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, and :help news for noteworthy changes in the latest version!
Install from package
Pre-built packages for Windows, macOS, and Linux are found on the Releases page.
Managed packages are in Homebrew, Debian, Ubuntu, Fedora, Arch Linux, Void Linux, Gentoo, and more!
Install from source
See BUILD.md and supported platforms 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=RelWithDebInfo
sudo 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 helplists all build targets.build/CMakeCache.txt(orcmake -LAH build/) contains the resolved values of all CMake variables.build/compile_commands.jsonshows the full compiler invocations for each translation unit.
Transitioning from Vim
See :help nvim-from-vim for instructions.
Project layout
├─ 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/ Vimscript 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)
License
Neovim contributions since b17d96 are licensed under the
Apache 2.0 license, except for contributions copied from Vim (identified by the
vim-patch token). See LICENSE.txt for details.