savq/paq-nvim

github github
plugin-manager
star 472
stars
alert-circle 16
open issues
users 7
subscribers
git-branch 26
forks
CREATED

2020-09-19

UPDATED

18 days ago


Paq

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 250 LOC

Requirements

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 Windows:

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";          -- Mind the semi-colons
    "hrsh7th/nvim-cmp";

    {"lervag/vimtex", opt=true};      -- Use braces when passing options
}

Then, source your configuration (using :source % or :luafile %) and run :PaqInstall.

NOTICE: Calling the paq function per package is deprecated. Users should now pass a list to the 'paq' module instead.

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 operations listed above.

Options

Option Type
as string Name to use for the package locally
branch string Branch of the repository
opt boolean Optional packages are not loaded on startup
pin boolean Pinned packages are not updated
run string Shell command to run after install/update
run function Lua function to run after install/update
url string URL of the remote repository, useful for non-GitHub repos

For more details on each option, refer to the documentation.

You can find a comparison with other package managers in the wiki.