Zinit ZSH Plugin Manager
Manage zsh plugins, CLI binary installs, and completions using zinit in this dotfiles repo.
Repo Structure
This repo uses GNU Stow. Files symlink to $HOME:
.zshrc- main zinit config, plugin definitions, binary installs.config/zsh/- modular zsh configs loaded viazinit snippetplugins.zsh- additional plugin loadsaliases.zsh- shell aliasesexports.zsh- PATH and env varscompletions.zsh- completion setupcompletions/- custom completion files (_just, _inv, etc.)history.zsh,keys.zsh,styles.zsh- other configs
Quick Reference
Binary Install Pattern (gh-r)
zinit as"null" wait lucid from"gh-r" for \
sbin"binary-name" owner/repo
With Completion Generation
zinit for \
from'gh-r' \
sbin'tool' \
atclone'./tool completion zsh > _tool' atpull'%atclone' as'completion' \
@owner/repo
OMZ Plugin/Snippet
zinit wait lucid for \
OMZP::plugin-name \
OMZL::lib-file.zsh
Build from Source
zinit for \
as'null' \
configure'--prefix=$PWD' \
make'install' \
sbin \
@owner/repo
Key Ice Modifiers
| Ice | Purpose |
|---|---|
from'gh-r' |
Download from GitHub releases |
sbin'pattern -> name' |
Create bin symlink in $ZPFX/bin |
wait"N" |
Turbo load after N seconds |
lucid |
Suppress "Loaded..." message |
atclone"cmd" |
Run on clone |
atpull'%atclone' |
Run atclone on update |
as'completion' |
Register as completion |
as'null' |
Don't source as plugin |
Detailed References
For comprehensive patterns and troubleshooting, see:
references/ice-modifiers.md- all ice options with examplesreferences/patterns.md- common install patternsreferences/troubleshooting.md- load order, debugging