Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zap-zsh/zap
:zap: Zap is a minimal zsh plugin manager
https://github.com/zap-zsh/zap
plugin-manager sh shell zsh zshell
Last synced: 7 days ago
JSON representation
:zap: Zap is a minimal zsh plugin manager
- Host: GitHub
- URL: https://github.com/zap-zsh/zap
- Owner: zap-zsh
- License: gpl-3.0
- Created: 2022-10-24T15:40:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T18:33:36.000Z (8 months ago)
- Last Synced: 2025-01-12T03:42:03.082Z (14 days ago)
- Topics: plugin-manager, sh, shell, zsh, zshell
- Language: Shell
- Homepage: https://www.zapzsh.com/
- Size: 170 KB
- Stars: 1,018
- Watchers: 10
- Forks: 39
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-linux-ricing - zap
- jimsghstars - zap-zsh/zap - :zap: Zap is a minimal zsh plugin manager (Shell)
README
---
:zap: Zap is a minimal `zsh` plugin manager
## Prerequisites
- [ZSH](https://www.zsh.org/)
- a nerd font (optional)
To get your nerd font check out [getNF](https://github.com/ronniedroid/getnf) project or visit [NerdFonts](https://www.nerdfonts.com/) site.
## Install
```zsh
zsh <(curl -s https://raw.githubusercontent.com/zap-zsh/zap/master/install.zsh) --branch release-v1
```
> [!TIP]
> If you wish to keep your current `.zshrc` file, you may add the `-k or --keep` argument when executing the install script.
**Zap works on Linux, macOS, Windows (within WSL), Android (within Termux)**
## Example usage
Add the following to your `.zshrc`
```zsh
# Example install of plugins
plug "zap-zsh/supercharge"
plug "zsh-users/zsh-autosuggestions"
# Example install of a plugin pinned to specifc commit or branch, just pass the git reference
plug "zsh-users/zsh-syntax-highlighting" "122dc46"
# Example install of a theme
plug "zap-zsh/zap-prompt"
# Example install of a zsh completion
plug "esc/conda-zsh-completion"
```
You can also use `Zap` to install custom plugins or source custom files present on your local filesystem. A file descriptor which points to a directory is treated as a plugin, versus a regular file. For example:
```zsh
# Example install of a local plugin
plug "$HOME/plugins/my-custom-prompt"
# Example sourcing of local files
plug "$HOME/.config/zsh/aliases.zsh"
plug "$HOME/.config/zsh/exports.zsh"
# Example install all local plugin in a folder (must be an absolute path anding with *)
plug "$HOME/plugins/*"
```
By default `Zap` when installing a plugin will clone a GitHub repository using a HTTPS web URL, if you require to be able to install from a private GitHub or from a different git server (for example GitLab) you can provide a different URL prefix to be used. For example:
```zsh
# Example globally setting the prefix for Zap to git clone using an SSH key
export ZAP_GIT_PREFIX="[email protected]:"
plug "zap-zsh/private-repo"
# Example git clone using GitLab for a single plugin
ZAP_GIT_PREFIX="https://gitlab.com/" plug "user/repo"
```
It is possible to call `plug` in any interactive shell session to source a file or to download and source a plugin for that particular session.
:warning: If you call `plug` outside your `.zshrc` file, the plugin you sourced will not be sourced at the next shell reload.
## Commands
Zap provided commands for updating and cleaning up plugins
- To update plugins or Zap:
```zsh
zap update self # Update the Zap installation
zap update plugins # Update all your plugins but not Zap
zap update all # Update both the Zap installation and its plugins
```
- To list all plugins you are using:
```zsh
zap list
```
- To remove plugins you are no longer using:
```zsh
zap clean
```
## Uninstall
To uninstall Zap, when currently active, execute the following:
```zsh
rm -rf "$ZAP_DIR"
```
When not currently active, execute the following:
```zsh
rm -rf "${XDG_DATA_HOME:-$HOME/.local/share}/zap"
```
## Notes
For sourcing local files use `$HOME` instead of `~` when giving a full path to the file.
---
[](https://www.youtube.com/watch?v=LhDMw6n3GI4)
## Socials
## Thanks to all contributors
