Skip to content

Latest commit

 

History

739 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zi logo

Zi

A high-performance plugin manager and toolkit for Zsh.

Install plugins, snippets, completions, themes, and command-line tools with precise control over how they are downloaded, configured, and loaded.

Latest release MIT License Zsh

Quick start  ·  Documentation  ·  Releases  ·  Discussions

Zi is the Z-Shell ecosystem's plugin manager. It can source a single remote script, manage a complete plugin, install a binary release, run build steps, or defer work until after the first prompt. Zi was formerly known as zplugin and zinit.

Built for real Zsh setups

Capability What it gives you
Responsive startup Turbo mode defers plugin work until after the prompt without giving up declarative configuration.
Flexible sources Load Git repositories, standalone scripts, Oh My Zsh and Prezto snippets, completions, and release artifacts.
Precise control Ice modifiers describe download, build, selection, loading, and update behavior for each dependency.
Tool management Install command-line tools and packages without root access, then expose them through your shell environment.
Extensible design Annexes add focused capabilities without expanding the core into a monolith.

Quick start

1. Install Zi

Run the minimal installer. It downloads Zi and adds the minimal setup to your .zshrc:

sh -c "$(curl -fsSL get.zshell.dev)" --

Review the installer source and its published SHA-256 checksum before running a remote installation script.

2. Add your first plugins

Add Zi commands to .zshrc. This example loads an Oh My Zsh snippet, command suggestions, and fast syntax highlighting:

# ~/.zshrc
zi snippet OMZ::plugins/git/git.plugin.zsh
zi light zsh-users/zsh-autosuggestions
zi light z-shell/F-Sy-H

snippet loads a standalone script. light loads a plugin without tracking and reporting overhead.

3. Reload Zsh

exec zsh -il

Run zi -h to explore the available commands. For alternate installers, manual setup, completions, and post-install steps, see the full installation guide.

Learn by task

I want to... Read...
Understand plugin and snippet loading General overview
Control how a dependency is installed and loaded Ice modifiers
Customize Zi paths and behavior Configuration
Explore commands and maintenance workflows Commands
Discover plugins, annexes, and packages Ecosystem

Community and support

Contributing

Contributions are welcome. Read the contribution guide before opening an issue or pull request. Development work targets the next branch, while main contains production releases.

Security

Please follow the Z-Shell security policy to report vulnerabilities privately. Do not disclose a vulnerability in a public issue before a fix is available.

License

Zi is available under the MIT License.

About

✨ A Swiss Army Knife for Zsh - Unix Shell

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

908 stars

Watchers

6 watching

Forks

Releases

Packages

Used by

Contributors

Languages