Skip to main content

⚙️ Console

A console for ZI – based on the zsh/zcurses Zshell module allows the user to:

  • View the currently loaded plugins in a colorful list, in one of 3 different display modes,
  • Unload and load plugins,
  • Delete the plugins and snippets from the disk.

Prerequisities: ZUI library.

ZI console usage

Start the console by Ctrl-O Ctrl-J keyboard shortcut, or by running ziconsole function in the shell. Then, in the console:

Ctrl-U,Ctrl-DHalf page up; half page down
Ctrl-P,Ctrl-NPrevious line, centered; next line, centered
Ctrl-LRedraw of whole display
[, ]Jump to next and previous section (e.g.: next plugin or snippet)
g, GJump to beginning and end of whole interface
<,> or {,}Horizontal scroll (i.e.: left or right)
/Show incremental search
F1Jump to result (in incremental search) and back
EscExit incremental search, clearing query
Ctrl-WDelete whole word (in incremental search)
Ctrl-KDelete whole line (in incremental search)



Install console

Load like any other normal plugin, e.g.:

with use of turbo mode and the for syntax:

zi wait lucid for z-shell/zi-console

The plugin needs zsh/curses Zsh module. You can check if it's available to your Zsh by executing:

zmodload zsh/curses

If the call will return an error, then the zsh/curses module isn't available.

Solving The Lack Of zsh/curses Module With ZI

You can build the zsh/curses-equipped Zshell with ZI by the following command:

zi ice id-as"zsh" atclone"./.preconfig        CFLAGS='-I/usr/include -I/usr/local/include -g -O2 -Wall' \        LDFLAGS='-L/usr/lib -L/usr/local/lib' ./configure --prefix='$ZPFX'" \    atpull"%atclone" run-atpull make"install" pick"/dev/null"zi load zsh-users/zsh

The command will build a custom zsh and install it under $ZPFX (~/.zi/polaris by default). The path $ZPFX/bin is already added to $PATH by ZI at first position, so starting zsh will run the new Zshell.

When on Gentoo, and possibly other systems, the zsh can still not have the ncurses library linked. To address this, utilize the z-a-patch-dl annex and automatically patch the source first:

zi light z-shell/z-a-patch-dlzi ice id-as"zsh" atclone"./.preconfig        CFLAGS='-I/usr/include -I/usr/local/include -g -O2 -Wall' \        LDFLAGS='-L/usr/lib -L/usr/local/lib' ./configure --prefix='$ZPFX'" \    dl" -> curses.patch" \    patch'curses.patch' atpull"%atclone" reset \    run-atpull make"install" pick"/dev/null"zi load zsh-users/zsh

Then, to update, rebuild and reinstall the zsh, you can do zi update zsh. The binary can be safely copied over /bin/zsh as it has paths to all needed directories built-in.