Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fsouza/paq-nvim
Neovim package manager (fork with support for pinning specific references)
https://github.com/fsouza/paq-nvim
neovim neovim-plugin package-manager
Last synced: 20 days ago
JSON representation
Neovim package manager (fork with support for pinning specific references)
- Host: GitHub
- URL: https://github.com/fsouza/paq-nvim
- Owner: fsouza
- License: mit
- Created: 2022-09-01T21:37:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-01T21:37:45.000Z (over 2 years ago)
- Last Synced: 2024-11-14T14:47:44.989Z (3 months ago)
- Topics: neovim, neovim-plugin, package-manager
- Language: Lua
- Homepage:
- Size: 188 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
- git
- [Neovim](https://github.com/neovim/neovim) ≥ 0.5
## Installation
Clone this repository.
For Unix-like systems:
```sh
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:
```lua
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 |
| ref | string | Commit hash to pin the repo on (can also be set to a tag) |
| url | string | URL of the remote repository, useful for non-GitHub repos |
For more details on each option, refer to the
[documentation](https://github.com/savq/paq-nvim/tree/master/doc/paq-nvim.txt).
## Related projects
You can find a [comparison](https://github.com/savq/paq-nvim/wiki/Comparisons)
with other package managers in the [wiki](https://github.com/savq/paq-nvim/wiki).