ZIM - Zsh IMproved FrameWork
zsh
Go to file
Dequan Zhang b792a0f0d9 update submodules 2018-07-07 23:08:37 +00:00
.github Update to new repo URL 2018-01-03 10:30:12 -05:00
modules update submodules 2018-07-07 23:08:37 +00:00
templates Source syntax-highlighting after completion 2018-05-31 19:17:04 -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 update submodules 2018-07-07 23:07:05 +00:00
LICENSE.md use markdown MIT license 2016-02-18 00:04:06 -05:00
README.md Update README.md 2018-07-07 09:03:56 -07:00
init.zsh use less code 2018-07-07 21:02:21 +00:00
login_init.zsh update login logic 2018-07-07 20:46:30 +00:00

README.md

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.

Speed

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

Themes

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

Fish-shell History Navigation

history-substring-search

Syntax Highlighting

syntax-highlighting

And much more!

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

Installation

Installing Zim is easy. If you have a different shell framework installed (like oh-my-zsh or prezto), uninstall those first to prevent conflicts. Then put following instructions at the end of your ~/.zshrc:

# Zim initializition
export ZIM_HOME="$HOME/.zsh"

if [ ! -f "$ZIM_HOME/init.zsh" ]; then
  echo "Installing zim"
  git clone --recursive https://github.com/zimfw/zimfw.git $ZIM_HOME
  git clone https://github.com/Piping/fzf-zsh.git $ZIM_HOME/modules/fzf-zsh
  cat $ZIM_HOME/templates/zlogin >> $HOME/.zlogin
  source $HOME/.zlogin
fi

zmodules=(git git-info prompt completion syntax-highlighting autosuggestions fzf-zsh)
zprompt_theme='steeef'
zhighlighters=(main brackets cursor)

source $ZIM_HOME/init.zsh #make sure init after zmodules lists etcs..

You're done! Enjoy your Zsh IMproved! Take some time to read about the available modules and tweak your .zshrc file.

Updating

To update zim, run:

zmanage update

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

Uninstalling

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!