Skip to content

A curses consolette for Zsh-Zplugin plugin manager

License

Notifications You must be signed in to change notification settings

tortious/zplugin-console

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zplugin Console

A consolette for Zplugin – based on the zsh/zcurses Zshell module and the ZUI library – it 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.

Usage

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

Key(s) Description
Ctrl-U,Ctrl-D Half page up; half page down
Ctrl-P,Ctrl-N Previous line, centered; next line, centered
Ctrl-L Redraw of whole display
[, ] Jump to next and previous section (e.g.: next plugin or snippet)
g, G Jump to beginning and end of whole interface
<,> or {,} Horizontal scroll (i.e.: left or right)
/ Show incremental search
F1 Jump to result (in incremental search) and back
Esc Exit incremental search, clearing query
Ctrl-W Delete whole word (in incremental search)
Ctrl-K Delete whole line (in incremental search)

Screencast

asciicast

Installation

Load like any other normal plugin, e.g.:, with use of Turbo mode:

zplugin ice wait lucid
zplugin load zplugin/zplugin-console

The plugin needs zsh/curses Zsh module. 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 Zplugin

You can build the zsh/curses-equipped Zshell with Zplugin by:

zplugin 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"
zplugin load zsh-users/zsh

The command will build a custom zsh and install it under $ZPFX (~/.zplugin/polaris by default). The path $ZPFX/bin is already added to $PATH by Zplugin 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:

zplugin light zplugin/z-a-patch-dl
zplugin 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"https://gist.githubusercontent.com/psprint/2373494c71cb6d1529344a2ed1a64b03/raw -> curses.patch" \
    patch'curses.patch' atpull"%atclone" reset \
    run-atpull make"install" pick"/dev/null"
zplugin load zsh-users/zsh

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

About

A curses consolette for Zsh-Zplugin plugin manager

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages