GitHub - savq/paq-nvim: 🌚 Neovim package manager (original) (raw)
Paq is a Neovim package manager written in Lua.
Features
- Simple: Easy to use and configure
- Fast: Installs and updates packages concurrently using Neovim's event-loop
- Small: Around 500 LOC
Requirements
- git
- Neovim latest stable
Note
If your are using older versions of neovim, such as the one present in debian stable, you need to use the debian branch.
The debian branch is not subject of backports so if you experience any bugs you need to upgrade your neovim version.
Installation
Clone this repository.
For Unix-like systems:
git clone --depth=1 https://github.com/savq/paq-nvim.git
"${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/pack/paqs/start/paq-nvim
For Debian Stable:
git clone --depth=1 --branch=debian https://github.com/savq/paq-nvim.git
"${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/pack/paqs/start/paq-nvim
For Windows (cmd.exe):
git clone https://github.com/savq/paq-nvim.git %LOCALAPPDATA%\nvim-data\site\pack\paqs\start\paq-nvim
For Windows (powershell):
git clone https://github.com/savq/paq-nvim.git "$env:LOCALAPPDATA\nvim-data\site\pack\paqs\start\paq-nvim"
To install Paq automatically or to install your plugins in --headless mode see the documentation section :h paq-bootstrapping.
Usage
In your init.lua, require the "paq" module with a list of packages, like:
require "paq" { "savq/paq-nvim", -- Let Paq manage itself "neovim/nvim-lspconfig", { "lervag/vimtex", opt = true }, -- Use braces when passing options { 'nvim-treesitter/nvim-treesitter', build = ':TSUpdate' }, }
Then, source your configuration (executing :source $MYVIMRC) and run :PaqInstall.
Commands
PaqInstall: Install all packages listed in your configuration.PaqUpdate: Update all packages already on your system (it won't implicitly install them).PaqClean: Remove all packages (in Paq's directory) that aren't listed on your configuration.PaqSync: Execute the three commands listed above.
Options
| Option | Type | |
|---|---|---|
| as | string | Name to use for the package locally |
| branch | string | Branch of the repository |
| build | function | Lua function to run after install/update |
| build | string | Shell command to run after install/update |
| build | string | Prefixed with a ':' will run a vim command |
| opt | boolean | Optional packages are not loaded on startup |
| pin | boolean | Pinned packages are not updated |
| url | string | URL of the remote repository, useful for non-GitHub repos |
For more details on each option, refer to thedocumentation.
Related projects
You can find a comparisonwith other package managers in the wiki.