z 🐀

Quick, simple zsh plugin manager

zr 0.7.1
Jonathan Dahan <hi@jonathan.is>
z:rat: - zsh plugin manager

USAGE:
    zr [OPTIONS] [SUBCOMMAND]

FLAGS:
        --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -h, --home <home>    Sets a custom directory for plugins

SUBCOMMANDS:
    help      Prints this message or the help of the given subcommand(s)
    list      list plugins
    load      load plugins fresh
    update    update plugins

install

You can use crates.io and cargo to just cargo install zr

usage

Add this to your ~/.zshrc:

# Generate new ~/.zr/init.zsh if it does not exist or ~/.zshrc is newer
if [[ ! -f ~/.zr/init.zsh ]] || [[ ~/.zshrc -nt ~/.zr/init.zsh ]]; then
  zr load \
    frmendes/geometry \
    jedahan/geometry-hydrate \
    junegunn/fzf/shell/key-bindings.zsh  # just load key-bindings.zsh
fi

source ~/.zr/init.zsh

If you'd like a different directory for ~/.zr, just set ZR_HOME

identifiers

zr supports four identifier formats, note that the last format requires .git as a delimeter.

format	resolves to
author/name	*.zsh from https://github.com/author/name
author/name/file.zsh	file.zsh from https://github.com/author/name
https://gitlab.com/a/plugin	*.zsh from https://gitlab.com/a/plugin
https://gitlab.com/a/plugin.git/file.zsh	file.zsh from https://gitlab.com/a/plugin.git. The .git is used as a delimeter, and is required.

speed

The following benchmark.zsh takes 171ms total, with 26ms spent in zr load for my 2012 13" retina macbook pro.

# install hyperfine for benchmarking
cargo install hyperfine

# benchmark zr init time
hyperfine --warmup 3 'zsh -d -f -l -c "source benchmark.zsh && zrinit && exit"' | grep Time
Time (mean ± σ):      26.0 ms ±   1.6 ms

# benchmark total zsh load time
hyperfine --warmup 3 'zsh -d -f -l -c "source benchmark.zsh && zrinit && source ~/.zr/init.zsh && exit"' | grep Time
Time (mean ± σ):     171.6 ms ±  4.4 ms

# benchmark.zsh
function zrinit {
  zr load sorin-ionescu/prezto/modules/git/alias.zsh \
    sorin-ionescu/prezto/modules/history/init.zsh \
    junegunn/fzf/shell/key-bindings.zsh \
    zsh-users/zsh-autosuggestions \
    zdharma/fast-syntax-highlighting \
    molovo/tipz \
    geometry-zsh/geometry \
    jedahan/geometry-hydrate \
    jedahan/geometry-todo \
    geometry-zsh/geometry \
    ael-code/zsh-colored-man-pages \
    momo-lab/zsh-abbrev-alias \
    jedahan/alacritty-completions \
    zpm-zsh/ssh
}

thanks

• SX91 for linux fixes
• alanpearce for bug reports and nix package
• nshtg for bug reports and windows fix
• foray1010 for improving install instructions
• everyone on #rust-beginners