Home

Awesome

Paq

Paq is a Neovim package manager written in Lua.

Features

Requirements

NOTE Paq follows the Neovim version available in Debian stable.

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 (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

Options

OptionType
asstringName to use for the package locally
branchstringBranch of the repository
buildfunctionLua function to run after install/update
buildstringShell command to run after install/update
buildstringPrefixed with a ':' will run a vim command
optbooleanOptional packages are not loaded on startup
pinbooleanPinned packages are not updated
urlstringURL of the remote repository, useful for non-GitHub repos

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

Related projects

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