~yerinalexey/miniplug

ref: 5522023d46f39dc3c14a852833f0a2a325049be4 miniplug/README.md -rw-r--r-- 1.9 KiB
5522023d — Alexey Yerin chore: moving to Codeberg 11 months ago

#miniplug

Minimalistic plugin manager for ZSH

#Features

  • No crashes or double plugin loading when re-sourcing .zshrc
  • Unlike Antigen, Miniplug does not pollute your $PATH
  • Only bare minimum for managing plugins

#Requirements

  • ZSH
  • Git
  • awk (gawk)

#Installation

To install Miniplug you need to download miniplug.zsh file and source it in your .zshrc:

curl \
  -sL --create-dirs \
  https://codeberg.org/YerinAlexey/miniplug/raw/branch/master/miniplug.zsh \
  -o $HOME/.miniplug/miniplug.zsh

# Add to zshrc:
source "$HOME/.miniplug/miniplug.zsh"

You can download this file anywhere, $HOME/.miniplug/miniplug.zsh is just an example

#Usage

After miniplug.zsh file is sourced, you'll get access to miniplug CLI utility. Define plugins using miniplug plugin <URL>. Or define a theme using miniplug theme <URL> (theme can be set only once)

<URL> can be URL to Git repo or Github's user/repo

After plugins are defined, you can download them using miniplug install and source them using miniplug load (should be added to .zshrc).

#Example .zshrc:

source "$HOME/.miniplug/miniplug.zsh"

# Define a plugin
miniplug plugin 'zsh-users/zsh-syntax-highlighting'

# Define a theme
miniplug theme 'dracula/zsh'

# Source plugins
miniplug load

#Changing plugin folder

Plugins will be downloaded to ~/.miniplug by default, to change that location, set MINIPLUG_HOME environment variable with a new path:

export MINIPLUG_HOME="$HOME/.local/share/miniplug"

#Updating plugins

To update plugins you can run:

miniplug update

If you want to force plugin not to update, you can just detach HEAD by doing git checkout <COMMIT HASH> in plugin folder ($MINIPLUG_HOME/user/repo). In that case, plugin will be skipped when you run miniplug update

#License

MIT, learn more