Skip to main content

🏗 Preferences & Configuration

Hash parameter

The following variables can be set to custom values, before sourcing Zi.

# Initial Zi's hash definitiontypeset -A ZI

Variables has to be set before loading Zi, i.e source "path/to/zi/bin/zi.zsh".

Customize paths

Hash FieldDescription
ZI[BIN_DIR]Where Zi code resides, e.g: "~/.zi/bin"
ZI[HOME_DIR]Where Zi should create all working directories, e.g: "~/.zi"
ZI[PLUGINS_DIR]Override single working directory – for plugins, e.g: "/opt/zsh/zi/plugins"
ZI[COMPLETIONS_DIR]As above, but for completion files, e.g: "/opt/zsh/zi/root_completions"
ZI[SNIPPETS_DIR]As above, but for snippets
ZI[ZMODULES_DIR]Override single working directory – for Zsh modules e.g: "/opt/zsh/zi/zmodules"
ZI[ZCOMPDUMP_PATH]Path to .zcompdump file, with the file included (e.g: its name can be different)
ZPFXDirectory where binary and their related files are stored (software with Makefile can use atclone'./configure --prefix=$ZPFX'). Set by default to $ZI[HOME_DIR]}/polaris.
ZI[MAN_DIR]Directory where plugins can store their manpages (atclone"cp -vf man.1 $ZI[MAN_DIR]/man1"). If overridden, this directory will not necessarily be used by man. Default: ${ZPFX}/man

Modify settings

Hash FieldDescription
ZI[OPTIMIZE_OUT_DISK_ACCESSES]If set to 1, then Zi will skip checking if a Turbo-loaded object exists on the disk. By default, Zi skips turbo mode for non-existing objects (plugins or snippets) to install them before the first prompt – without any delays, during the normal processing of .zshrc. This option can give a performance gain of about 10 ms out of 150 ms (e.g: Zsh will start up in 140 ms instead of 150 ms).
ZI[COMPINIT_OPTS]Options for compinit call (e.g: done by zicompinit), use to pass -C to speed up loading
ZI[MUTE_WARNINGS]If set to 1, then mutes some of the Zi warnings, specifically the plugin already registered warning
ZI[PKG_OWNER]Change the owner of the packages (zi pack …).

Non-GitHub (Local) Plugins

Use the create subcommand with user name _local (the default) to create the plugin's skeleton in $ZI[PLUGINS_DIR]. It will be not connected with the GitHub repository (because of the user name being _local). To enter the plugin's directory use the cd command with just the plugin's name (without _local, it's optional).

If the user name will not be _local, then Zi will create a repository also on GitHub and set up the correct repository origin.

Extending Git

Several projects provide git extensions. Installing them with Zi has many benefits:

  • all files are under $HOME – no administrator rights are needed,
  • declarative setup (like Chef or Puppet) – copying .zshrc to a different account brings also git-related setup,
  • easy update by e.g: zi update --all.

Below is a configuration that adds multiple git extensions, loaded in Turbo mode, 1 second after prompt, with the use of the bin-gem-node annex:

zi as"null" wait"1" lucid for \    sbin    Fakerr/git-recall \    sbin    cloneopts paulirish/git-open \    sbin    paulirish/git-recent \    sbin    davidosomething/git-my \    sbin atload"export _MENU_THEME=legacy" \            arzzen/git-quick-stats \    sbin    iwata/git-now \    make"PREFIX=$ZPFX install" \            tj/git-extras \    sbin"bin/git-dsf;bin/diff-so-fancy" \            z-shell/zsh-diff-so-fancy \    sbin"git-url;git-guclone" make"GITURL_NO_CGITURL=1" \            z-shell/git-url

The target directory for installed files is $ZPFX - ~/.zi/polaris by default.

With meta-plugins consisting of:


  1. z-shell/z-a-readurl,
  2. z-shell/z-a-patch-dl,
  3. z-shell/z-a-rust,
  4. z-shell/z-a-bin-gem-node.

Git tools:

  1. paulirish/git-open,
  2. paulirish/git-recent,
  3. davidosomething/git-my,
  4. arzzen/git-quick-stats,
  5. iwata/git-now,
  6. tj/git-extras,
  7. wfxr/forgit.

just run:

zi light-mode for z-shell/z-a-meta-plugins @annexes @ext-git

Zsh options: setopt

Options are primarily referred to by name. These names are case insensitive and underscores are ignored. For example, allexport is equivalent to A__lleXP_ort.

The sense of an option name may be inverted by preceding it with no, so setopt No_Beep is equivalent to unsetopt beep. This inversion can only be done once, so nonobeep is not a synonym for beep. Similarly, tify is not a synonym for nonotify (the inversion of notify).

Some options also have one or more single-letter names. There are two sets of single letter options: one used by default, and another used to emulate sh/ksh (used when the SH_OPTION_LETTERS option is set). The single letter options can be used on the shell command line, or with the set, setopt and unsetopt builtins, as normal Unix options preceded by -.

The sense of the single letter options may be inverted by using + instead of -. Some of the single letter option names refer to an option being off, in which case the inversion of that name refers to the option is on. For example, +n is the short name of exec, and -n is the short name of its inversion, noexec.

In strings of single letter options supplied to the shell at startup, trailing whitespace will be ignored; for example the string -f will be treated just as -f, but the string -f i is an error.

This is because many systems which implement the #! mechanism for calling scripts do not strip trailing whitespace.

History optimization

setopt hist_ignore_all_dups    Remove older duplicate entries from history.setopt hist_expire_dups_first  Expire A Duplicate Event First When Trimming History.setopt hist_ignore_dups        Do Not Record An Event That Was Just Recorded Again.setopt hist_reduce_blanks      Remove superfluous blanks from history items.setopt hist_find_no_dups       Do Not Display A Previously Found Event.setopt hist_ignore_space       Do Not Record An Event Starting With A Space.setopt hist_save_no_dups       Do Not Write A Duplicate Event To The History File.setopt hist_verify             Do Not Execute Immediately Upon History Expansion.setopt append_history          Allow multiple terminal sessions to all append to one zsh command history.setopt extended_history        Show Timestamp In History.setopt inc_append_history      Write To The History File Immediately, Not When The Shell Exits.setopt share_history           Share history between different instances of the shell

Other tweaks

setopt bang_hist             Treat The '!' Character Specially During Expansion.setopt multios               Perform implicit tees or cats when multiple redirections are attempted.setopt interactive_comments  Allow comments even in interactive shells (especially for Muness).setopt pushd_ignore_dups     Don't push multiple copies of the same directory onto the directory stack.setopt auto_cd               Use cd by typing directory name if it's not a command.setopt no_beep               Don't beep on error.setopt auto_list             Automatically list choices on ambiguous completion.setopt auto_pushd            Make cd push the old directory onto the directory stack.setopt pushdminus            Swapped the meaning of cd +1 and cd -1; we want them to mean the opposite of what they mean.setopt promptsubst           Enables the substitution of parameters inside the prompt each time the prompt is drawn.

Style control for the completion system zstyle

What does zstyle do? -

The zstyle handles the obvious style control for the completion system, but it seems to cover more than just that. e.g., the vcs_info module relies on it for the display of git status in your prompt.

You can start by looking at the few explanatory paragraphs in man zshmodules in the zstyle section.

Fuzzy matching of completions

zstyle ':completion:*' completer _complete _match _approximatezstyle ':completion:*:match:*' original onlyzstyle -e ':completion:*:approximate:*' max-errors 'reply=($((($#PREFIX+$#SUFFIX)/3>7?7:($#PREFIX+$#SUFFIX)/3))numeric)'

Pretty completions

zstyle ':completion:*:matches' group 'yes'zstyle ':completion:*:options' description 'yes'zstyle ':completion:*:options' auto-description '%d'zstyle ':completion:*:corrections' format ' %F{green}-- %d (errors: %e) --%f'zstyle ':completion:*:descriptions' format ' %F{yellow}-- %d --%f'zstyle ':completion:*:messages' format ' %F{purple} -- %d --%f'zstyle ':completion:*:warnings' format ' %F{red}-- no matches found --%f'zstyle ':completion:*:default' list-prompt '%S%M matches%s'zstyle ':completion:*' format ' %F{yellow}-- %d --%f'zstyle ':completion:*' group-name ''zstyle ':completion:*' verbose yeszstyle ':completion:*' matcher-list 'm:{a-zA-Z}={A-Za-z}' 'r:|[._-]=* r:|=*' 'l:|=* r:|=*'zstyle ':completion:*:functions' ignored-patterns '(_*|pre(cmd|exec))'zstyle ':completion:*' use-cache truezstyle ':completion:*' rehash true

Do menu-driven completion

zstyle ':completion:*' menu select

Color completion for some things

zstyle ':completion:*' list-colors ${(s.:.)LS_COLORS}

Disabling System-Wide compinit Call (Ubuntu)

On Ubuntu users might get surprised that e.g. their completions work while they didn't call compinit in their .zshrc.

That's because the function is being called in /etc/zshrc.

To disable this call – what is needed to avoid the slowdown and if the user loads any completion-equipped plugins, i.e. almost on 100% – add the following line to ~/.zshenv to skip the not helping Ubuntu global compinit:


Multiple prompts

load'…'condition that when fulfilled will cause the plugin to be loaded.
unload'…'as above, but will unload the plugin.

zi light … loads the plugin without tracking it, while zi load tracks the plugin. To be able to unload the plugin, it has to be loaded with zi load … instead of zi light ….

atload'!…'run the precmd hooks to make the prompts fully initialized when loaded in the middle of the prompt.
precmdhooks are normally run before each new prompt.

Exclamation mark causes the effects of the functions to be tracked.

To allow better unloading, conditions are checked every second, you can use conditions like:

![[ $PWD == *github* ]]Change prompt after changing directory to *github*.
![[ $MYPROMPT = 1 ]]Change prompt when variable MYPROMPT = 1 is true.
![[ … ]]The exclamation mark causes the prompt to be reset after loading or unloading the plugin pick'/dev/null' – disable sourcing of the default-found file.
multisrc'…'Source multiple files.
lucidDon't show the under-prompt message that says e.g: Loaded geometry-zsh/geometry.
nocdDon't cd into the plugin's directory when executing the atload'…'.
atload'…'This ice can make the path that's displayed by the theme point to that directory.

Loading and unloading themes (8 examples)

1 - zprompts

zi lucid load'![[ $MYPROMPT = 1 ]]' unload'![[ $MYPROMPT != 1 ]]' \  atload'!promptinit; typeset -g PSSHORT=0; prompt sprint3 yellow red green blue' nocd for \    z-shell/zprompts

2 – lambda-mod-zsh-theme

zi lucid load'![[ $MYPROMPT = 2 ]]' unload'![[ $MYPROMPT != 2 ]]' nocd for \    halfo/lambda-mod-zsh-theme

3 – lambda-gitster

zi lucid load'![[ $MYPROMPT = 3 ]]' unload'![[ $MYPROMPT != 3 ]]' nocd for \    ergenekonyigit/lambda-gitster

4 – geometry

zi lucid load'![[ $MYPROMPT = 4 ]]' unload'![[ $MYPROMPT != 4 ]]' \  atload'!geometry::prompt' nocd \  atinit'GEOMETRY_COLOR_DIR=63 GEOMETRY_PATH_COLOR=63' for \    geometry-zsh/geometry

5 – pure

zi lucid load'![[ $MYPROMPT = 5 ]]' unload'![[ $MYPROMPT != 5 ]]' \  pick"/dev/null" multisrc"{async,pure}.zsh" atload'!prompt_pure_precmd' nocd for \    sindresorhus/pure

6 - agkozak-zsh-theme

zi lucid load'![[ $MYPROMPT = 6 ]]' unload'![[ $MYPROMPT != 6 ]]' \  atload'!_agkozak_precmd' nocd atinit'AGKOZAK_FORCE_ASYNC_METHOD=subst-async' for \    agkozak/agkozak-zsh-theme

7 - zinc

zi load'![[ $MYPROMPT = 7 ]]' unload'![[ $MYPROMPT != 7 ]]' \  compile"{zinc_functions/*,segments/*,zinc.zsh}" nocompletions \  atload'!prompt_zinc_setup; prompt_zinc_precmd' nocd for \    robobenklein/zinc

8 - git-prompt

zi lucid load'![[ $MYPROMPT = 8 ]]' unload'![[ $MYPROMPT != 8 ]]' \  atload'!_zsh_git_prompt_precmd_hook' nocd for \    woefe/git-prompt.zsh