ZIM - Zsh IMproved FrameWork
Go to file
Eric Nielsen 78611457f2 [input] Only load terminfo feature of zsh/terminfo
and use `-F` to check if the feature was not already loaded before.

Use terminfo elements for Backspace and Delete. Sort by terminfo element

Also simplify code, removing unnecessary double quotes, and replacing
if-then-fi with one command by one-liners.
2018-04-13 15:23:53 -05:00
.github Update to new repo URL 2018-01-03 10:30:12 -05:00
modules [input] Only load terminfo feature of zsh/terminfo 2018-04-13 15:23:53 -05:00
templates [meta] Move zmanage to function in init.zsh 2017-11-24 19:08:39 -05:00
tools Update to new repo URL 2018-01-03 10:30:12 -05:00
.gitignore Ignore *.zwc.old files when compiling functions 2017-11-24 19:08:39 -05:00
.gitmodules [autosuggestions] Add module 2017-06-08 09:33:26 -05:00
LICENSE.md use markdown MIT license 2016-02-18 00:04:06 -05:00
README.md Remove old link to meta module in README 2018-04-03 08:52:04 -05:00
init.zsh And also simplify functions glob in init.zsh 2018-04-09 18:20:54 -05:00
login_init.zsh Also still not zrecompile prompt_*_setup files 2018-04-09 18:12:34 -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. It can be installed manually by following the instructions below:

  1. In a Zsh shell, clone the repository:
git clone --recursive https://github.com/zimfw/zimfw.git ${ZDOTDIR:-${HOME}}/.zim
  1. Paste this into your terminal to prepend the initialization templates to your configs:
for template_file ( ${ZDOTDIR:-${HOME}}/.zim/templates/* ); do
  touch ${user_file}
  ( print -rn "$(<${template_file})$(<${user_file})" >! ${user_file} ) 2>/dev/null
  1. Set Zsh as the default shell:
chsh -s =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.


To update zim, run:

zmanage update

For more information about the zmanage tool, run zmanage help.


The best way to remove zim is to manually delete ~/.zim, ~/.zimrc, and remove the initialization lines from your ~/.zshrc.

However, there are some experimental convenience functions to remove zim:

NOTE: This functionality is experimental!

To remove zim, run:

zmanage remove

NOTE: This functionality is experimental!