Skip to content

Latest commit

 

History

History
114 lines (70 loc) · 1.76 KB

README.md

File metadata and controls

114 lines (70 loc) · 1.76 KB
Raw

zpm - Zsh Plugin Manager ![Gitter](https://badges.gitter.im/Join Chat.svg) Build Status

zsh plugin manager in ansi C.

Installation

Clone this repository and then:

make

You'll have a zpm binary in the current directory, copy it to /usr/local/bin.

Usage

Installing plugins

You first will need to install the plugins you want:

zpm "zsh-users/zsh-syntax-highlighting"
zpm "zsh-users/zsh-autosuggestions"
zpm "rupa/z"

These commands will generate $HOME/.zpm-init.zsh file. Use that to load plugins.

Configure zsh

Then configure zsh to use them:

# .zshrc
source $HOME/.zpm-init.zsh

If you add or remove new plugins you will need to:

zpm reset

Commands

To see a list of installed plugins:

zpm list

To update installed plugins:

zpm update

To persist your current configuration to be able to commit it into a dotfile repository:

zpm save

Example:

zpm save > ~/dotfiles/.zpmrc

Next time you'll only need to install them like so:

source ~/dotfiles/.zpmrc

To reset your plugin configuration:

zpm reset

To disable a plugin from loading:

zpm disable "plugin/name"

To disable and remove a plugin from disk:

zpm remove "plugin/name"

Development

Running tests:

make test

You'll need zcram (or cram) installed and available in PATH.

Maintainers

zpm is currently being actively developed by @desyncr and @fennecdjay.

TODO

  • Update command
  • Add plugins to fpath
  • Support for local plugins
  • List command show version (hash)
  • Add executables to PATH