ZIM - Zsh IMproved FrameWork
Go to file
Matt Hamilton d52993c70e add 'custom' module for easy customization 2015-12-22 05:55:48 -05:00
modules add 'custom' module for easy customization 2015-12-22 05:55:48 -05:00
templates load-time optimizations 2015-12-20 20:42:48 -05:00
.gitignore add 'custom' module for easy customization 2015-12-22 05:55:48 -05:00
.gitmodules add liquidprompt 2015-12-18 03:56:51 -05:00
LICENSE add MIT License 2015-12-15 22:33:12 -05:00
README.md clarify install zsh shell 2015-12-19 16:53:09 -05:00
init.zsh use consistent variable style 2015-12-19 09:48:29 -05:00


ZIM - Zsh IMproved

What is Zim?

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

Zim is very easy to customize, and comes with a rich set of modules and features without compromising on speed or functionality!

What does Zim offer?

If you're here, it means you want to see the cool shit Zim can do. Check out the available modules!

Below is a brief showcase of Zim's features.


For a speed comparison between Zim and other frameworks, see this wiki entry.


To preview some of the available themes, check the themes wiki page.

Fish-shell History Navigation


Syntax Highlighting


And much more!

Zim has many modules! Enable as many or as few as you'd like.


Installing Zim is easy. If you have a different shell framework installed (like oh-my-zsh or prezto), uninstall those first to prevent conflicts.

  1. In a Zsh shell, clone the repository:
git clone --recursive https://github.com/Eriner/zim.git ${ZDOTDIR:-${HOME}}/.zim
  1. Copy the template configuration files (or append to existing configs):
for template_file ( ${ZDOTDIR:-${HOME}}/.zim/templates/* ); do
  cat ${template_file} | tee -a ${ZDOTDIR:-${HOME}}/.$(basename ${template_file}) > /dev/null
  1. Set Zsh as the default shell:
chsh -s $(which zsh)
  1. Open a new terminal and finish optimization (this is only needed once, hereafter it will happen upon desktop/tty login):
source ${ZDOTDIR:-${HOME}}/.zlogin
  1. You're done! Enjoy your Zsh IMproved! Take some time to read about the available modules and tweak your .zshrc file.