Explore the docs »
Report Bug
·
Request Feature
·
Ask Question
A modern approach to Neovim plugin management!
🌒
Cargo-likerocks.tomlfile for declaring all your plugins.- Name-based installation
(
"nvim-neorg/neorg"becomes:Rocks install neorginstead). - Automatic dependency and build script management.
- True semver versioning!
- Minimal, non-intrusive UI.
- Async execution.
- Extensible, with a Lua API.
- Command completions for plugins on luarocks.org.
- An up-to-date
Neovimnightly (>= 0.10) installation. - The
gitcommand line utility. wgetorcurl(if running on a UNIX system) - required for the remote:sourcecommand to work.netrwenabled in your Neovim configuration - enabled by default but some configurations manually disable the plugin.
Important
If you are running on Windows or an esoteric architecture, rocks.nvim will
attempt to compile its dependencies instead of pulling a prebuilt binary. For
the process to succeed you must have a C++17 parser and Rust
toolchain installed on your system.
The days of bootstrapping and editing your configuration are over.
rocks.nvim can be installed directly through an interactive installer within Neovim.
You just have to run the following command inside your editor and the installer will do the rest!
:source https://raw.githubusercontent.com/nvim-neorocks/rocks.nvim/master/installer.luaIf you already have plugins installed, we suggest running the installer without loading RC files, as some plugins may interfere with the script:
nvim -u NORC -c "source https://raw.githubusercontent.com/nvim-neorocks/rocks.nvim/master/installer.lua"Important
For security reasons, we recommend that you read :help :source
and the installer code before running it so you know exactly what it does.
You can install rocks with the :Rocks install {rock} {version?} command.
Arguments:
rock: The luarocks package.version: Optional. Used to pin a rock to a specific version.
Note
- The command provides fuzzy completions for rocks and versions on luarocks.org.
- Installs the latest version if
versionis omitted. - This plugin keeps track of installed plugins in a
rocks.tomlfile, which you can commit to version control.
Running the :Rocks update command will attempt to update every available rock
if it is not pinned.
The :Rocks sync command synchronizes the installed rocks with the rocks.toml.
Note
- Installs missing rocks.
- Ensures that the correct versions are installed.
- Uninstalls unneeded rocks.
To uninstall a rock and any of its dependencies,
that are no longer needed, run the :Rocks prune {rock} command.
Note
- The command provides fuzzy completions for rocks that can safely be pruned without breaking dependencies.
The :Rocks edit command opens the rocks.toml file for manual editing.
Make sure to run :Rocks sync when you are done.
By default, rocks.nvim will source all plugins at startup.
To prevent it from sourcing a plugin, you can specify opt = true
in the rocks.toml file.
For example:
[plugins]
neorg = { version = "1.0.0", opt = true }or
[plugins.neorg]
version = "1.0.0"
opt = trueYou can then load the plugin with the :Rocks[!] packadd {rock} command.
Note
A note on loading rocks:
Luarocks packages are installed differently than you are used to from Git repositories.
Specifically, luarocks installs a rock's Lua API to the package.path
and the package.cpath.
It does not have to be added to Neovim's runtime path
(e.g. using :Rocks packadd), for it to become available.
This does not impact Neovim's startup time.
Runtime directories (:h runtimepath),
on the other hand, are installed to a separate location.
Plugins that utilise these directories may impact startup time
(if it has ftdetect or plugin scripts), so you may or may
not benefit from loading them lazily.
The :Rocks log command opens a log file for the current session,
which contains the luarocks stderr output, among other logs.
This plugin provides a Lua API for extensibility.
See :h rocks.api for details.
Following are some examples:
rocks-git.nvim: Adds the ability to install plugins from git.rocks-config.nvim: Adds an API for safely loading plugin configurations.
To extend rocks.nvim, simply install a module with :Rocks install,
and you're good to go!
rocks.nvim is licensed under GPLv3.
Contributions are more than welcome! See CONTRIBUTING.md for a guide.