Skip to main content

⚡️ Installation

Quick setup

Place the following snippet to the .zshrc file:

source <(curl -sL; zzinit

Reload the shell with exec zsh -il and run zi -h for usage information.

Automated setup

  • Verify the sha256 checksum for file: lib/sh/
  • If required append -b <tag> or -b <branch> e.g:
sh -c "$(curl -fsSL" -- -i skip -b main

Install and include minimal configuration to the .zshrc:

sh -c "$(curl -fsSL" --

Manual Setup

Set up the install location and create a directory:

typeset -Ag ZI
typeset -gx ZI[HOME_DIR]="${HOME}/.zi" ZI[BIN_DIR]="${ZI[HOME_DIR]}/bin"
command mkdir -p "$ZI[BIN_DIR]"

For security reasons run function compaudit to check if the completion system would use files owned by root or by the current user, or files in directories that are world or group-writable.

If failed, then set the current user as the owner of directories, then remove group/others write permissions, and clone the repository:

compaudit | xargs chown -R "$(whoami)" "$ZI[HOME_DIR]"
compaudit | xargs chmod -R go-w "$ZI[HOME_DIR]"
command git clone "$ZI[BIN_DIR]"

To enable Zi, source the zi.zsh from the previously set up directory placing the following snippet in the .zshrc file:

typeset -A ZI
source "${ZI[BIN_DIR]}/zi.zsh"

The two lines below must be placed after the lines above, i.e. after enabling Zi.

Enable Zi completions:

autoload -Uz _zi
(( ${+_comps} )) && _comps[zi]=_zi


After a fresh install, it is recommended to reload the shell and recompile Zi with:

  • exec zsh -il
  • zi self-update

Run zi -h for available commands or explore wiki to extend, customize and create 👍 🎉.

If you have any issue or need help 🤦‍♂️, lets discuss it or open an issue on GitHub.

It helps us to improve and make Zi better. Don't forget to help the project: share, contribute, or translate 🌐 🥰 🤓.

Let's glue a toolchain that works for us 🚀.

Have ideas?

 Suggest or request at playground

sh -c "$(curl -fsSL" -- -a ???

 Need warm-up?

 Docker Alpine

docker run --rm -it

Turbo Zi in Docker

If you create a Docker image that uses Zi, install Turbo-loaded plugins before the shell starts interactively, with the @zi-scheduler function in such a way, that it:

  • Install plugins without waiting for the prompt (i.e. it's script friendly).
  • Install all plugins instantly, without respecting the wait argument.

To accomplish this, use burst argument and call the @zi-scheduler function:

RUN zsh -i -c -- '@zi-scheduler burst || true'

Zi Module: zpmod

The module transparently and automatically compiles sourced scripts and lists of all sourced files with the time the sourcing took in milliseconds on the left.

Status page


GitHub RAW


GitHub RAW