Skip to main content

Variables Reference

Set these in ~/.zshrc before zflash boot. ZFLASH_HOME and ZFLASH_CACHE must be set before source …/zflash.zsh.

Read at tells you when a change takes effect: start means the next shell; build means after the next zflash build.

VariableDefaultRead atMeaning
ZFLASH_HOME$XDG_DATA_HOME/zflash or ~/.local/share/zflashstartRepositories live in $ZFLASH_HOME/repos.
ZFLASH_CACHE$XDG_CACHE_HOME/zflash or ~/.cache/zflashstartInit file, manifest, compdump, update log.
ZFLASH_AUTO_UPDATE7startDays between background updates; 0 disables them.
ZFLASH_COMPINITdeferbuilddefer: cached compinit after the first prompt. sync (or 1): before it. 0: don't run compinit.
ZFLASH_COMPINIT_TTL24buildHours to trust the completion dump before a full rescan.
ZFLASH_COMPDUMP$ZFLASH_CACHE/compdump-$ZSH_VERSIONstartCompletion dump path.
ZFLASH_GIT_HOSThttps://github.combuildHost for owner/repo specs.
ZFLASH_OMZ_LIB_SKIP(compfix cli diagnostics)buildoh-my-zsh lib/ files (without .zsh) to skip. Array.

Variables zflash sets​

VariableMeaning
ZFLASH_VERSIONVersion of the loaded zflash, e.g. 0.2.0.
ZFLASH_SRCDirectory zflash was sourced from. Useful for upgrading: git -C "$ZFLASH_SRC" pull.
ZFLASH_SPECAbsolute path of the spec passed to zflash boot.
ZFLASH_INIT$ZFLASH_CACHE/init.zsh.

Installer variables​

Used only by install.sh.

VariableDefaultMeaning
ZFLASH_SPEC$XDG_CONFIG_HOME/zflash/plugins.zsh or ~/.config/zflash/plugins.zshSpec to create or use when --spec isn't given.
ZFLASH_INSTALL_DIR$XDG_DATA_HOME/zflash/zflash or ~/.local/share/zflash/zflashWhere to clone zflash when not run from a checkout.
ZFLASH_REPOhttps://github.com/arastu/zflash.gitRepository to clone.
VariableMeaning
ZSH_CACHE_DIRoh-my-zsh cache, including generated completions. Default ~/.cache/oh-my-zsh. Set before zflash boot to change.