awesome-zsh-plugins

Awesome

Status

License Build Status Join the chat at https://gitter.im/unixorn/awesome-zsh-plugins GitHub stars Code Climate Issue Count GitHub last commit (branch) Track Awesome List

A collection of ZSH frameworks, plugins, tutorials & themes inspired by the various awesome list collections out there.

Table of Contents

Please read the Contributing Guidelines before contributing.

Frameworks

These frameworks make customizing your ZSH setup easier.

You can find some interesting performance timing comparisons of various frameworks in the following locations.

alf

Alf is an out of this world super fast and configurable framework for ZSH; it’s modeled after Prezto and Antigen while utilizing Oh-My-Zsh under the covers; and offers standard defaults, aliases, functions, auto completion, automated updates and installable prompt themes and plugins.

ansible-role-zsh

ansible-role-zsh is an ansible role with zero-knowledge installation. It uses antigen to manage bundles and oh-my-zsh. Can load bundles conditionally. By default it includes powerlevel9k theme, autosuggestions, syntax-highlighting and fzf-widgets and fzf-marks. Fully customizable.

ant-zsh

Ant-zsh is a tiny and lightweight ZSH configuration environment for special customization needs. It includes plugins, themes and a basic convenient setup.

antibody

Antibody is a faster and simpler antigen written in Golang. More details at http://getantibody.github.io/.

antigen-hs

antigen-hs is a replacement for antigen optimized for a low overhead when starting up the shell. It will automatically clone plugins for you.

antigen

Antigen is a small set of functions that help you easily manage your shell (ZSH) plugins, called bundles. The concept is pretty much the same as bundles in a typical vim+pathogen setup. Antigen is to ZSH, what Vundle is to vim. Antigen can load oh-my-zsh themes and plugins and will automatically clone them for you.

ax-zsh

Ax-ZSH is a modular configuration system for ZSH. It provides sane defaults and is extendable by plugins.

dotzsh

Dotzsh strives to be platform and version independent. Some functionality may be lost when running under older versions of ZSH, but it should degrade cleanly and allow you to use the same setup on multiple machines of differing OSes without problems.

fresh

fresh is a tool to source shell configuration (aliases, functions, etc) from others into your own configuration files. We also support files such as ackrc and gitconfig. Think of it as Bundler for your dot files.

miniplug

miniplug is a minimalistic plugin manager for ZSH.

mzpm

mzpm is a minimalist plugin manager for ZSH.

oh-my-zsh

oh-my-zsh is a community-driven framework for managing your ZSH configuration. Includes 120+ optional plugins (rails, git, macOS, hub, capistrano, brew, ant, macports, etc), over 120 themes to spice up your morning, and an auto-update tool that makes it easy to keep up with the latest updates from the community.

PMS

PMS allows you to manage your shell in a way to that helps decrease setup time and increases your productivity. It has support for themes (change the way your shell looks), plugins (adds functionality to your shell), and dotfile management.

The PMS framework also allows you to use the same framework in different shells. Use ZSH on your personal laptop, and use bash on remote servers. Wanna try fish? Go ahead, try out different shells.

prezto

Prezto enriches the ZSH command line interface environment with sane defaults, aliases, functions, auto completion, and prompt themes. There are some prezto-specific plugins at https://github.com/belak/prezto-contrib.

pumice

Pumice is a lightweight plugin manager for ZSH.

pz

A plugin manager for ZSH doesn’t have to be complicated to be powerful. PZ doesn’t try to be clever when it can be smart. PZ is a full featured, fast, and easy to understand plugin manager encapsulated in a single file with about 200 lines of clean ZSH.

PZ does just enough to manage your ZSH plugins really well, and then gets out of your way. ### sheldon

A fast, configurable, shell plugin manager.

Toasty

Toasty is a ZSH framework made to facilitate management, not dictate it.

tzpm

The tiniest ZSH plugin manager. Still under development.

uz

A ZSH micro plugin manager.

yazt

Yazt is a simple zsh theme manager in maintence that is compatible with nearly everything. You can use prompts in plugins, mix ‘n’ match two themes, with a few modifications, you can even use it in bash.

zapack

zapack is a basic fast minimal ZSH plugin loader.

zeesh

Zeesh is a cross-platform ZSH framework. It’s similar to, but incompatible with, oh-my-zsh. It has a modular plugin architecture making it easy to extend. It has a rich set of defaults, but is designed to be as lightweight as possible.

zgem

Zgem is a plugin manager for ZSH that supports loading and updating plugins and themes from git, http and local files.

zgen

Zgen is a lightweight plugin manager for ZSH inspired by Antigen. The goal is to have minimal overhead when starting up the shell because nobody likes waiting. It is currently not being actively maintained and I recommend you use the zgenom fork instead, which is.

zgenom

A lightweight plugin manager for ZSH that is a fork that extends the brilliant zgen and provides more features and bugfixes while being fully backwards compatible.

To keep loading fast during new terminal sessions, zgenom generates a static init.zsh file which does nothing but source your plugins and append them to your fpath.

This minimizes startup time by not having to execute time consuming logic (plugin checking, updates, etc) during startup. The downside is that you have to refresh the init script manually with zgenom reset whenever you update your plugin list in your .zshrc.

Zgenom can load oh-my-zsh-compatible and prezto-compatible plugins and themes, and will automagically git clone plugins for you when you add them to your plugin list.

zilsh

zilsh is a ZSH config system that aims to appeal more to power-users and follow the simplistic approach of vim-pathogen.

zim

Zim is a ZSH configuration framework with blazing speed and modular extensions.

Zinit

Zinit is an innovative and probably (because of the Turbo) the fastest plugin manager with support for:

Bonus: you can use zinit-console to view and change the state of the ZSH session (e.g.: list and unload plugins) and to delete the plugins and snippets from the disk.

The project is very active – currently > 3100 commits.

zit

zit is a plugin manager for ZSH. It is minimal because it implements the bare minimum to be qualified as a plugin manager: it allows the user to install plugins from Git repositories (and Git repositories only, them why the name), source plugins and update them. It does not implement fancy functions like cleanup of removed plugins, automatic compilation of installed plugins, alias for oh-my-zsh/prezto/other ZSH frameworks, building binaries, PATH manipulation and others.

znap

:zap:Znap is a light-weight plugin manager & Git repo manager for ZSH that’s easy to grok. While tailored for ZSH plugins specifically, Znap also functions as a general-pupose utility for managing Git repos.

Znap

Znap can:

zoppo

Zoppo is the crippled configuration framework for ZSH. As an Italian saying goes: “chi va con lo zoppo, impara a zoppicare”, we realized we were walking with a cripple and are now going to become crippled ourselves.

zpacker

Zpacker is a lightweight ZSH plugin & theme management framework.

zpico

The minuscule ZSH package manager. No frills, no bloat, just 2 kB of 100% ZSH code, providing complete package management for your ZSH environment.

zplug

:hibiscus: Zplug is a next-generation ZSH plugin manager.

zpm

zpm ( ZSH Plugin Manager ) is a plugin manager for ZSH who combines the imperative and declarative approach. At first run, zpm will do complex logic and generate cache, after that will be used cache only, so it makes this framework to be very fast.

zr

zr is a quick, simple ZSH plugin manager written in Rust and easily installable with cargo install zr.

zshing

zshing is a ZSH plugin manager similar to Vundle/Vim and allows you to…

ztanesh

Ztanesh aims to improve your UNIX command line experience and productivity with the the configuration provided by the ztanesh project: the tools will make your shell more powerful and easier to use.

ztheme

ztheme is a small and fast theme engine for ZSH.

ztupide

A simple and fast ZSH plugin manager. It uses zcompile and async loading to speed up your shell startup time.

zulu

Zulu is a environment manager for ZSH 5+, which aims to make it easy to manage your shell without writing any code.

Setups

This section is for full setup dropins - they aren’t frameworks, but they’re not simple plugins/themes either.

zgenom

zinit

Tutorials

Generic ZSH

Antigen

Oh-My-Zsh

Prezto

Zgen

Zinit (née zplugin)

ZSH on Windows

Plugins

Completions

These plugins add tab completions without adding extra functions or aliases.

Themes

If you’re using Antigen, you can test these themes in a running ZSH with antigen theme githubuser/repo. If you’re using zgen, add them to your init.zsh with zgen load githubuser/reponame.

Fonts

Some of the themes listed here require Powerline-compatible fonts, here are a few:

Installation

Antigen

Most of these plugins can be installed by adding antigen bundle githubuser/reponame to your .zshrc file. Antigen will handle cloning the plugin for you automatically the next time you start zsh. You can also add the plugin to a running ZSH with antigen bundle githubuser/reponame for testing before adding it to your .zshrc.

dotzsh

  1. Clone new plugins into .zsh.local/modules
  2. Load the plugin module in .zshrc
  3. Open a new ZSH terminal window or tab

Oh-My-Zsh

  1. cd ~/.oh-my-zsh/custom/plugins
  2. git clone repo
  3. Add the repo to your plugin list

Prezto

  1. Clone the plugin into your prezto modules directory
  2. Add the plugin to your .zpreztorc file
  3. Open a new terminal window or tab

Zgen

Zgen is not being actively maintained. Consider switching to the Zgenom fork, which is.

Most of these plugins can be installed by adding zgen load githubuser/reponame to your .zshrc file in the same function you’re doing your other zgen load calls in.

Zgen will automatically clone the plugin repositories for you when you do a zgen save.

Zgenom

Most of these plugins can be installed by adding zgenom load githubuser/reponame to your .zshrc file in the same function you’re doing your other zgenom load calls in.

Zgenom will automatically clone the plugin repositories for you when you do a zgenom save.

zplug

Most of these plugins can be installed by adding zplug "githubuser/reponame" to your .zshrc file.

zpm

Most of these plugins can be installed by adding zpm load "githubuser/reponame" to your .zshrc file.

Writing New Plugins

I’ve documented some recommendations for writing a new plugin here.

Other Resources

ZSH Tools

Other Useful Lists

Find other useful awesome-* lists at the awesome collection

Other References

The ZSH Reference Card and zsh-lovers site are indispensable.