desyncr / zpm-zsh

Main repository: https://github.com/zpm-project/zpm-zsh

zpm - Zsh Plugin Manager 

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

zpm-zsh's Issues

Support repository hosts other than github

Allow for custom hosts/repository urls. For now use github.com by default, but allow for other hosts:

zpm "gitlab.com/repository/name"
zpm "bitbucket.com/user/plugin"

Fail to add local plugin to plugin_list

This happens when ~/.zpm does not exist yet.

Review multi-host support

• Review implementation to be fully host agnostic (github, bitbucket, etc)
• Avoid hardcoding hosts (try to...)
• Add tests

@fennecdjay I have yet no idea how to implement this so any suggestion is welcome!

We should discuss here before doing any PR :)

Add TravisCI support

• Use cram https://pypi.python.org/pypi/cram
• Create .travis.yml
• Update test suite for new commands (ie, update)

Segfault on clone on Ubuntu 16.04

Support local plugins

zpm should be able to install plugins from local path as well as github urls:

zpm "/path/to/local/plugin"   # /path/to/local/plugin
zpm "remote/plugin"           # github.com/remote/plugin.git

Add compinit autoload

This should be done in $HOME/.zpm-init.zsh:

autoload -Uz compinit
compinit -iCd $HOME/.zcompdump

'usage' does not reflect current state.

for now, it just prints:

Usage:
  zpm 'zsh-users/zsh-syntax-highlighting'

but I think it could add:

  zpm reset
  zpm list
  zpm update

What do you think? am I forgetting something?
I can do it and submit a pull request if you like.

Segfault on `list` command without any item

Update fpath and/or PATH

Generated ~/.zpm-init.zsh should add entries to fpath and/or PATH. This is necessary for plugins installing functions to fpath or executables to PATH. Example:

~/.zpm-init.zsh:

fpath+=(/path/to/plugin /path/to/other/plugin)

Update README.md for zpm's save command

Explain workflow with the save command. See #25 (comment)

double entry for github/host

./zpm zsh-users/zsh-syntax-highlighting
./zpm github.com/zsh-users/zsh-syntax-highlighting

cat ~/.zpm-init.zsh
source /home/djay/.zpm/plugins/zsh-users/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
fpath+=/home/djay/.zpm/plugins/zsh-users/zsh-syntax-highlighting/
autoload -Uz compinit; compinit -iCd $HOME/.zcompdump

cat ~/.zpm/.plugin_list
zsh-users/zsh-syntax-highlighting
github.com/zsh-users/zsh-syntax-highlighting

while ~/.zpm-init.zsh is correct, it appears that ~/.zpm/.plugin_list incorrectly reports two entries.

see #18.

Avoid installing plugin twice

If a user tries to install a plugin twice we should

1. warn the user the plugin in already installed
2. return immediately

Make shell agnostic (ie, support bash, sh, zsh, etc)

• Support adding completions
• Support both binary and functions
• Support themes/prompts