completion

April 9, 2026 ยท View on GitHub

Load and initialize the built-in zsh completion system.

Options

This plugin sets the following Zsh options:

actionoptiondescription
setoptALWAYS_TO_ENDMove cursor to the end of a completed word.
setoptAUTO_LISTAutomatically list choices on ambiguous completion.
setoptAUTO_MENUShow completion menu on a successive tab press.
setoptAUTO_PARAM_SLASHIf completed parameter is a directory, add a trailing slash.
setoptCOMPLETE_IN_WORDComplete from both ends of a word.
setoptPATH_DIRSPerform path search even on command names with slashes.
unsetoptFLOW_CONTROLDisable start/stop characters in shell editor.
unsetoptMENU_COMPLETEDo not autoselect the first completion entry.

Functions

This plugin adds the following functions:

functiondescription
run_compinitInitialize the Zsh completion system, with optional caching.
run_compinit -fForce a cache reset and reinitialize completions.

Aliases

This plugin sets no aliases.

Variables

This plugin sets the following variables:

variabledescription
ZSH_COMPDUMPPath to the zcompdump completion cache file.

Customizations

To cache compinit results (regenerated at most once per day):

zstyle ':zephyr:plugin:completion' 'use-cache' 'yes'

To allow insecure directories in fpath without warning:

zstyle ':zephyr:plugin:completion' 'disable-compfix' 'yes'

To run compinit immediately instead of deferring until after .zshrc:

zstyle ':zephyr:plugin:completion' 'immediate' 'yes'

To store ZSH_COMPDUMP in the XDG cache directory:

zstyle ':zephyr:plugin:completion' 'use-xdg-basedirs' 'yes'

To set the completion style (default: zephyr):

zstyle ':zephyr:plugin:completion' 'compstyle' 'zephyr'