ruimarinho / zsh-zoxide

⚙️ The ajeetdsouza/zoxide init for Zsh

❮ Plugin - Zsh zoxide ❯

The plugin calls zoxide init for Zsh.

zoxide is a smarter cd command, inspired by z and autojump.

The ajeetdsouza/zoxide

Options

Export the following environment variables to change the default behavior:

Variable	Description	Default
ZEC_DISABLED	Disable eval-caching	0
ZEC_DEBUG	Enable debug mode for eval-caching	0
ZEC_MAX	Maximum number to load from cache (until force refresh)	1000

Eval-cache files are stored in ${Plugins[ZSH_ZOXIDE]}/._zoxide/* directory.

Install zoxide

• Official install (recommended)
• With Zi:

zi ice as'null' from"gh-r" sbin
zi light ajeetdsouza/zoxide

Wiki: install fzf command-line fuzzy finder as Zi package.

Install zsh-zoxide

Note: the alternative for zsh-zoxide is 🌀 eval annex

Standard syntax

zi ice has'zoxide'
zi light z-shell/zsh-zoxide

The "For" syntax

zi has'zoxide' light-mode for \
  z-shell/zsh-zoxide

Turbo mode + "For" syntax

zi has'zoxide' wait lucid for \
  z-shell/zsh-zoxide

Wiki: automatic, condition based (loading/unloading)

Profile startup time

After loading the plugin – shows profiling results and then unloads zsh/zprof

zi ice has'zoxide' atinit'zmodload zsh/zprof' \
  atload'zprof | head -n 20; zmodload -u zsh/zprof'
zi light z-shell/zsh-zoxide

Environment variables and usage with Zi

The plugin will call zoxide init with prefixed commands x, xi:

• Completions auto-loaded: commands, ice-modifiers
• Manpage auto installed: $ZI[MAN_DIR]
• Database directory set: $ZPFX/share, customizing-paths

x foo              # cd into highest ranked directory matching foo
x foo bar          # cd into highest ranked directory matching foo and bar
x foo /            # cd into a subdirectory starting with foo

x ~/foo            # x also works like a regular cd command
x foo/             # cd into relative path
x ..               # cd one level up
x -                # cd into the previous directory

xi foo             # cd with interactive selection (using fzf)

x foo<SPACE><TAB>  # show interactive completions

Environment variables and usage with other plugin managers

The plugin will call zoxide init with prefixed commands z, and zi.