# zi
**Repository Path**: zdharma/zi
## Basic Information
- **Project Name**: zi
- **Description**: The Swiss Army Knife for Zsh Unix Shell. Gitee Mirror of https://github.com/z-shell/zi
- **Primary Language**: Shell
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://z.digitalclouds.dev/
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-02-07
- **Last Updated**: 2022-02-07
## Categories & Tags
**Categories**: Uncategorized
**Tags**: Zsh, zinit, Cli, Git, GitHub
## README
❮ ZI ❯
[](../LICENSE) [![Version][ver-badge]][ver-link]
[![Tweet][twitter-badge]][twitter-acc] [](https://open.vscode.dev/z-shell/zi) [](https://github.com/z-shell/zi-vim-syntax/)
《 Report an issue 》
·
《 Request a Feature 》
·
《 Ask a Question 》
Table of Contents
- 💡 Wiki Pages: [ [en](https://z-shell.pages.dev) ] [ [ja](https://z-shell.pages.dev/ja) ]
- [Installation](https://z-shell.pages.dev/docs/getting_started/installation)
- [Search](https://z-shell.pages.dev/search/)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Project assistance](#project-assistance)
- [Security](#security)
- [Acknowledgements](#acknowledgements)
- [Authors & contributors](#authors--contributors)
- [Support](#support)
---
**A Swiss Army Knife for [Zsh](https://zsh.sourceforge.io/) - [Unix shell](https://en.wikipedia.org/wiki/Unix_shell).**
- Has a [turbo mode](https://z-shell.pages.dev/docs/getting_started/overview#turbo-mode-zsh--53) which yields 50-80% [faster](https://github.com/z-shell/pm-perf-test) Zsh startup.
- Allow to install [**RubyGems**](https://rubygems.org/) [[1](https://z-shell.pages.dev/docs/ecosystem/annexes/bin-gem-node)] [[2](https://github.com/z-shell/any-gem)], [**Node modules**](https://www.npmjs.com/) [[1](https://z-shell.pages.dev/docs/ecosystem/annexes/bin-gem-node)] [[2](https://github.com/z-shell/any-node)], [**Rust packages**](https://crates.io/) [[1](https://z-shell.pages.dev/docs/ecosystem/annexes/rust)] and almost everything from [**GitHub**](https://github.com) [[1](https://z-shell.pages.dev/docs/ecosystem/annexes/meta-plugins)] [[2](https://z-shell.pages.dev/docs/gallery/collection)] [[3](https://z-shell.pages.dev/docs/ecosystem/annexes)] [[4](https://z-shell.pages.dev/docs/ecosystem/packages)].
- Supports loading [Oh My Zsh and Prezto](https://z-shell.pages.dev/docs/getting_started/overview#turbo-mode-zsh--53) plugins and libraries, however, the implementation isn't framework-specific and doesn't bloat the plugin manager with such code. See our wiki on how to [migrate](https://z-shell.pages.dev/docs/getting_started/migration) from other plugin managers.
- The dedicated [packages](https://z-shell.pages.dev/docs/ecosystem/packages) that offload the user from providing long and complex commands. See the [Z-Shell ZI](https://github.com/z-shell) organization for a complete list of packages.
- The [annexes](https://z-shell.pages.dev/docs/ecosystem/annexes) — allow to extend the plugin manager with new commands, URL-preprocessors (used by e.g.: [z-a-readurl](https://github.com/z-shell/z-a-readurl) annex), post-install and post-update hooks and much more.
- The system does not use `$FPATH`, loading multiple plugins don't clutter `$FPATH` with the same number of entries (e.g. `10`, `15` or more). Code is immune to `KSH_ARRAYS` and other options typically causing compatibility problems.
- Provides [reports and statistics](https://z-shell.pages.dev/docs/guides/commands#reports-and-statistics) about the plugins, such as describing what **aliases**, **functions**, **bindkeys**, **Zle widgets**, **zstyles**, [completions](https://z-shell.pages.dev/docs/getting_started/overview#completion-management), variables, `PATH` and `FPATH` elements a plugin has set up. Allows to quickly [familiarize](https://z-shell.pages.dev/docs/gallery/benchmarks) oneself with a new plugin and provides rich and easy-to-digest information that might be helpful on various occasions. supports the unloading of plugins and the ability to list, (un)install, and **selectively disable**, **enable** plugin's completions.
- Test configurations with docker at [playground](https://github.com/z-shell/playground)
- Capabilities: [0fuUpiPs](https://z-shell.github.io/docs/zsh/Zsh-Plugin-Standard.html#pmspec)
## 💡 Wiki Pages: [ [en](https://z-shell.pages.dev) ] [ [ja](https://z-shell.pages.dev/ja) ]
### [Installation](https://z-shell.pages.dev/docs/getting_started/installation)
### [Search](https://z-shell.pages.dev/search/)
## Roadmap
See the [open issues](https://github.com/z-shell/zi/issues) for a list of proposed features (and known issues).
- [Top Feature Requests](https://github.com/z-shell/zi/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Top issues](https://github.com/z-shell/zi/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Newest issues](https://github.com/z-shell/zi/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
## Contributing
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
Please read [our contribution guidelines](CONTRIBUTING.md), and thank you for being involved!
## Project assistance
If you want to say **thank you** or/and support active development of Z-Shell ZI :
- Add a [GitHub Star](https://github.com/z-shell/zi) to the project.
- [Tweet][twitter-link] about the ZI.
- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog.
Together, we can make Z-Shell ZI **better**!
## Security
- Z-Shell ZI follows good practices of security, but 100% security cannot be assured.
- Z-Shell ZI is provided **"as is"** without any **warranty**. Use at your own risk.
_For more information and to report security issues, please refer to our [security documentation](../docs/SECURITY.md)._
## Acknowledgements
The [**Z-Shell**](https://github.com/z-shell) was created to recover the `zdharma` organization project which was deleted by the owner.
We don't want to depend on an unreliable source.
[**ZI**](https://github.com/z-shell/zi), formerly known as zplugin, zinit, is an open source community project released under the [MIT License](../LICENSE).
## Authors & contributors
The original setup of this repository is by [Z-Shell ZI Community](https://github.com/z-shell).
For a full list of all authors and contributors, see [the contributors page](https://github.com/z-shell/zi/contributors).
## Support
Reach out to the maintainers at one of the following places:
- [GitHub Discussions](https://github.com/z-shell/zi/discussions)
- Contact options listed on [this GitHub profile](https://github.com/z-shell)
## Supporters
[ver-badge]: https://img.shields.io/github/tag/z-shell/zi.svg
[ver-link]: https://github.com/z-shell/zi/releases
[twitter-badge]: https://badgen.net/badge/icon/twitter?icon=twitter&label
[twitter-acc]: https://twitter.com/zshell_zi
[twitter-link]: https://twitter.com/intent/tweet?text=A%20Swiss%20Army%20Knife%20for%20Zsh%20-%20Unix%20shell%20%20@zshell_zi&url=https://github.com/z-shell/zi&hashtags=zsh,zi,zshell 
