Fork 0
mirror of synced 2024-05-29 21:41:10 -04:00
ZIM - Zsh IMproved FrameWork
Go to file
Eric Nielsen edd4e82d8a
[ssh] Update init.zsh
based on https://stackoverflow.com/a/48509425/2654518, which is based on

Current code has a few issues: depends on `SSH_AUTH_SOCK` and
`SSH_AGENT_PID` env variables, which might not be available in every
shell session; and tries to create a new socket for agent-forwarding by
checking `SSH_AUTH_SOCKET` instead of `SSH_AUTH_SOCK`.

Also, it's safer to create the env file with 066 mode and in the user
home directory.

About not using `$` inside `(( ))`, this is what the the section
ARITHMETIC EVALUATION in zshmisc(1) says:

> Named parameters and subscripted arrays can be referenced by name
> within an arithmetic expression without using the parameter expansion
> syntax.

And according to http://www.bash2zsh.com/zsh_refcard/refcard.pdf:

> `var` (does not require `$` in front unless some substitution e.g.
> `${#var}` is needed, `$` is error if `var` is to be modified)

Closes #292
2018-09-17 15:38:48 -05:00
.github Update to new repo URL 2018-01-03 10:30:12 -05:00
modules [ssh] Update init.zsh 2018-09-17 15:38:48 -05: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 [autosuggestions] Add module 2017-06-08 09:33:26 -05:00
init.zsh Unify the for syntax 2018-04-25 08:59:19 -05:00
LICENSE.md use markdown MIT license 2016-02-18 00:04:06 -05:00
login_init.zsh Unify the for syntax 2018-04-25 08:59:19 -05:00
README.md Unify the for syntax 2018-04-25 08:59:19 -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 in ${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!