Zi
✨ A Swiss Army Knife for Zsh - Unix Shell
Install / Use
/learn @z-shell/ZiREADME
<table style="background-color:transparent;">
<tr>
<td>
<h1 align="center">
<a target="_self" href="https://github.com/z-shell/zi">
<img style="width: 60px; height: 60px"
src="https://raw.githubusercontent.com/z-shell/zi/main/docs/images/logo.svg" alt="❮ Zi ❯ Logo" />
</a>❮ <strong>Zi</strong> ❯
</h1>
<h2 align="center">
🧙♂️ 🪄 A Swiss Army Knife for <a href="https://zsh.sourceforge.io/"><strong>Zsh</strong></a> -
<a href="https://en.wikipedia.org/wiki/Unix_shell">Unix Shell ✨</a>
</h2>
<div align="center">
<a
href="https://github.com/z-shell/zi/issues/new?assignees=&labels=bug+%F0%9F%90%9E&template=01_bug_report.yml&title=bug%3A+"><strong>《
Report an issue </strong></a>
·
<a
href="https://github.com/z-shell/zi/issues/new?assignees=&labels=feature-request+%F0%9F%92%A1&template=02_feature_request.yml&title=feat%3A+"><strong>《
Request a Feature 》</strong></a>
·
<a href="https://discussions.zshell.dev/"><strong>《 Ask a Question 》</strong></a>
</div>
</tr>
</td>
<tr>
<td>
<div align="center">
<a href="https://wiki.zshell.dev/search/"><strong>《💡》Search Wiki </strong></a>
<a href="https://wiki.zshell.dev/docs/getting_started/installation/"><strong>《⚡️》 Install </strong></a>
<a
href="https://github.com/z-shell/community/issues/new?assignees=&labels=%F0%9F%91%A5+member&template=membership.yml&title=team%3A+"><strong>《💜》Join
</strong></a>
<a href="https://translate.zshell.dev/"><strong>《🌐》Localize </strong></a>
</div>
</td>
</tr>
<tr>
<td>
<div align="center">
<a title="Z-Shell Matrix" target="_self" rel="nofollow" href="https://matrix.to/#/#zshell:matrix.org">
<img align="center" src="https://badgen.net/matrix/members/zshell/matrix.org" alt="Zi Matrix" />
</a>
<a title="Zi Gitter Matrix" target="_self" rel="nofollow" href="https://matrix.to/#/#z-shell_zi:gitter.im">
<img align="center" src="https://badgen.net/matrix/members/z-shell_zi/gitter.im" alt="Zi Gitter Matrix" />
</a>
<a title="Crowdin" target="_self" href="https://translate.zshell.dev/">
<img align="center" src="https://badges.crowdin.net/e/f108c12713ee8526ac878d5671ad6e29/localized.svg" />
</a>
<a title="Releases" target="_self" href="https://github.com/z-shell/zi/releases">
<img align="center" src="https://img.shields.io/github/tag/z-shell/zi.svg" alt="Version" />
</a>
<a title="License" target="_self" href="https://github.com/z-shell/zi/blob/main/LICENSE">
<img align="center" src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Project License" />
</a>
<a title="VIM" target="_self" href="https://github.com/z-shell/zi-vim-syntax/">
<img align="center" src="https://img.shields.io/badge/--019733?logo=vim" alt="VIM" />
</a>
<a target="_self" href="https://open.vscode.dev/z-shell/zi/">
<img align="center" src="https://img.shields.io/badge/--007ACC?logo=visual%20studio%20code&logoColor=ffffff"
alt="Visual Studio Code" />
</a>
</div>
</tr>
</td>
<tr>
<td>
<div align="center">
<a href="https://asciinema.org/a/509113" target="_blank"><img src="https://asciinema.org/a/509113.svg" /></a>
</div>
</tr>
</td>
<tr>
<td>
<div align="center">
<img align="center" style="width: 80%; height: auto"
src="https://github.com/z-shell/.github/raw/main/metrics/plugin/followup/zi_followup.svg" />
<img align="center" style="width: 80%; height: auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/plugin/metrics.svg" />
</div>
</tr>
</td>
</table>
<hr />
<h2>🎯 Roadmap</h2>
<div align="justify">
Generally, new features will be introduced as a component to improve performance and compatibility and not to
force, but to allow the user <strong>decide</strong> and
<strong>choose</strong> the features. Let us know what should be <strong>improved</strong> and
<strong>maintained</strong> with a ⭐ on features you like and use:<br /><br />
</div>
<ul>
<li>
<a href="https://github.com/search?q=topic%3Azplugin+org%3Az-shell&type=Repositories">
⚙️ <b>Plugins</b></a>
</li>
<li>
<a href="https://github.com/search?q=topic%3Azannex+org%3Az-shell&type=Repositories">
🌀 <b>Annexes</b></a>
</li>
<li>
<a href="https://github.com/search?q=topic%3Azpackage+org%3Az-shell&type=Repositories">
📦 <b>Packages</b></a>
</li>
</ul>
<ul>
<li>
<a href="https://github.com/z-shell/zi/issues">See the open issues</a> for a list of proposed features
or subjects that need the support
</li>
<li>
<a href="https://github.com/z-shell/zi/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc">Top
feature requests</a>
- add your votes using the 👍 reaction
</li>
<li>
<a href="https://github.com/z-shell/zi/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc">Top
issues</a>, <a href="https://github.com/z-shell/zi/issues?q=is%3Aopen+is%3Aissue+label%3Abug">newest
issues</a> -
add your votes using the 👍 reaction
</li>
<li>
<a
href="https://github.com/z-shell/community/issues/new?assignees=&labels=%F0%9F%91%A5+member&template=membership.yml&title=team%3A+">Join</a>
the <a href="https://github.com/z-shell">Z-Shell</a> organization to collaborate and create or add your
plugins and features.
</li>
</ul>
<hr />
<h2 align="left">💞 Contributing</h2>
<div align="justify">
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 <b>greatly appreciated</b> and our
<b>target</b> support each other.
</div>
<div align="justify">
Please read <a href="https://github.com/z-shell/community/blob/main/docs/project/CONTRIBUTING.md">our contribution
guidelines</a>
before you start. Thank you for being involved!
</div>
<hr />
<h2 align="left">🆙 Project assistance</h2>
<div align="justify">If you want to say <b>thank you</b> or/and support the active development, add a <a
href="https://github.com/z-shell/zi">GitHub Star</a> to the project, and follow the
<a href="https://github.com/z-shell">Z-Shell</a> organization.
</div><br />
<div align="justify">Write interesting articles about the project on:
<a href="https://dev.to/">Dev.to</a>, <a href="https://medium.com/">Medium.com</a>,
<a href="https://news.ycombinator.com/news">Hacker News</a>,
<a href="https://www.reddit.com/r/zsh/">Reddit</a>, <a href="https://twitter.com/zshell_zi">Twitter</a>, or your blog.
Participate in the community by showing <a
href="https://github.com/z-shell/community/issues/new?assignees=&labels=%F0%9F%91%A5+member&template=membership.yml&title=team%3A+">interest</a>
in the project, as it may bring us together, then great things may happen. If you want but are not confident
about participating - do not hesitate to contact us so we can discuss the situation 👍.
</div>
<hr />
<h2 align="left">🛡️ Security</h2>
<div align="justify">
- Z-Shell <string>Zi</strong> follows good practices of security, but 100% security cannot be assured.</div>
<div align="justify">
- Z-Shell <string>Zi</strong> is provided <bold>"as is"</bold> without any <bold> warranty</bold>. Use at your
own risk.
</div>
<div align="justify">
- For more information and to report security issues, please refer to our
<a href="https://github.com/z-shell/zi/blob/main/docs/SECURITY.md">security
documentation</a>.
</div>
<hr />
<h2 align="left">ℹ️ Acknowledgements</h2>
<div align="justify">
The <a href="https://github.com/z-shell">Z-Shell</a> organization was created to recover the
<a href="https://github.com/zdharma">Zdharma</a> organization which was deleted by the owner for an unknown
reason. It took a lot of time and effort for all those who liked the project and were depending on it don't
want to depend on an unreliable source.
</div>
<div align="justify">
<a href="https://github.com/z-shell/zi">
<string>Zi</strong>
</a>, formerly known as zplugin, zinit, is an open-source
community project released under the
<a href="https://github.com/z-shell/zi/blob/main/LICENSE">MIT License</a>.
</div>
<hr />
<h2 align="left">🥇 Authors & contributors</h2>
<div align="justify">
Check the list of authors and contributors in this
<a href="https://github.com/z-shell/zi/contributors">repository</a> and all other repositories under the
<a href="https://github.com/z-shell">Z-Shell</a> organization. We will include
all showing interest or dedicating their time to taking part.
</div>
<hr />
<h2 align="left">⭐ Credits</h2>
<div align="center">
<a href="https://trunk.io" rel="nofollow">
<img style="width: 140px; height: 40px"
src="https://storage.googleapis.com/digital-space/img/brand/trunk/trunk-white.svg" alt="Trunk" />
</a>
<a href="https://crowdin.com/?utm_source=badge&utm_medium=referral&utm_campaign=badge-add-on" rel="nofollow">
<img style="width: 140px; height: 40px"
src="https://storage.googleapis.com/digital-space/img/brand/crowdin/localization-at-dark-rounded%402x.png"
alt="Crowdin | Agile localization for tech companies" />
</a>
<a href="https://www.digitalocean.com/?refcode=090bdb63f800&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge"
rel="nofollow">
<img style="width: 140px; height: 40px" src="https://web-platforms.sfo2.digitaloceanspaces.com/WWW/Badge%203.svg"
alt="DigitalOcean Referral Badge" />
</a>
<a href="https://cloudflare.com" rel="nofollow">
<img style="width: 140px; height: 40px"
src="https://st
