Default settings

The plugin configures ls-style aliases for eza. Set AUTOCD=1 before loading it to list directories automatically after cd.

If eza is missing, the plugin prints an error and returns without terminating the current Zsh session.

Variables

Variable	Description	Default
eza_user_params	Replace the default eza argument list.	unset
eza_extra_params	Append additional eza arguments after the defaults.	unset
AUTOCD	Enable automatic directory listing after cd when set to 1.	0

Default parameters

eza_params=(
  '--git' '--icons' '--group' '--group-directories-first'
  '--time-style=long-iso' '--color-scale=all'
)

Aliases

alias ls='eza ${(@)eza_params}'
alias l='eza --git-ignore ${(@)eza_params}'
alias ll='eza --all --header --long ${(@)eza_params}'
alias llm='eza --all --header --long --sort=modified ${(@)eza_params}'
alias la='eza -lbhHigUmuSa'
alias lx='eza -lbhHigUmuSa@'
alias lt='eza --tree ${(@)eza_params}'
alias tree='eza --tree ${(@)eza_params}'

Install

The eza should be present to use this plugin. Install eza with Zi:

zi ice from'gh-r' as'program' sbin'**/eza -> eza' atclone'cp -vf completions/eza.zsh _eza'
zi light eza-community/eza

With Zi

To install add to the .zshrc file:

zi light z-shell/zsh-eza

Install only if eza exists and enable auto list directories:

zi ice has'eza' atinit'AUTOCD=1'
zi light z-shell/zsh-eza

Install only if eza exists and enable auto list directories in turbo mode:

zi ice wait lucid has'eza' atinit'AUTOCD=1'
zi light z-shell/zsh-eza

Install only if eza exists and enable auto list directories in turbo mode with the for syntax:

zi wait lucid for \
  has'eza' atinit'AUTOCD=1' \
    z-shell/zsh-eza

With Oh My Zsh

Clone the repository and add zsh-eza to the plugins array in your .zshrc file:

git clone https://github.com/z-shell/zsh-eza \
  ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-eza

plugins=(... zsh-eza)

With Zplug

Add zplug z-shell/zsh-eza to your ~/.zshrc and re-open your terminal session.

With Antigen

Add to your .zshrc file:

antigen bundle z-shell/zsh-eza@main

Note: The @main branch suffix is required because this repository uses main as the default branch, while Antigen defaults to master.