Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MunifTanjim/zed
ZSH Plugin Manager
https://github.com/MunifTanjim/zed
zsh zsh-plugin zsh-plugin-manager
Last synced: about 2 months ago
JSON representation
ZSH Plugin Manager
- Host: GitHub
- URL: https://github.com/MunifTanjim/zed
- Owner: MunifTanjim
- License: mit
- Created: 2021-11-07T17:45:08.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-09T15:47:33.000Z (11 months ago)
- Last Synced: 2024-06-10T00:38:23.736Z (3 months ago)
- Topics: zsh, zsh-plugin, zsh-plugin-manager
- Language: Shell
- Homepage:
- Size: 15.6 KB
- Stars: 19
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zed
ZSH Plugin Manager. Yes, yet another one.
## Installation
```sh
declare -A ZED
ZED[CACHE_DIR]="${HOME}/.cache/zsh/.zed"
ZED[DATA_DIR]="${HOME}/.local/share/zsh/.zed"
if ! test -d "${ZED[DATA_DIR]}/self"; then
git clone --depth 1 https://github.com/MunifTanjim/zed.git "${ZED[DATA_DIR]}/self"
fi
source "${ZED[DATA_DIR]}/self/zed.zsh"
```
## Usage
You should load the plugins you want after running `zed init` and before running `zed done`.
**Initialization**:
```sh
zed init
```
**Normal Plugin**:
```sh
zed load github.com/momo-lab/auto-expand-alias
zed load github.com/trapd00r/LS_COLORS \
pick:'lscolors.sh' \
onpull:'dircolors -b LS_COLORS > lscolors.sh' \
onload:'zstyle ":completion:*" list-colors "${(s.:.)LS_COLORS}"'
zed load github.com/zpm-zsh/colorize
zed load github.com/zpm-zsh/ls
zed load github.com/zsh-users/zsh-completions
zed load github.com/zsh-users/zsh-autosuggestions
zed load github.com/zsh-users/zsh-syntax-highlighting
```
**Generated Script**:
```sh
if (( ${+commands[zoxide]} )); then
zed load github.com/MunifTanjim/null name:'zoxide' \
onpull:'zoxide init zsh > zoxide.plugin.zsh'
fi
if (( ${+commands[starship]} )); then
zed load github.com/MunifTanjim/null name:'starship' \
onpull:'starship init zsh --print-full-init > starship.plugin.zsh'
fi
```
**Local Script**:
```
zed load "${HOME}/.helpers.sh"
```
**[Oh My Zsh](https://github.com/ohmyzsh/ohmyzsh) Plugin**:
```sh
zed load github.com/ohmyzsh/ohmyzsh dir:'plugins/macos'
```
**Finalization**:
```sh
zed done
```
### Commands
The main function is named `zed`.
You don't like that name?!
In case you already have another function with the same name,
for example: the [`zed` command line editor](https://github.com/zsh-users/zsh/blob/master/Functions/Misc/zed),
just set the `ZED[name]` variable to something else before
sourcing the `zed.zsh` file.
```sh
ZED[name]=zedi
```
Then `zed` will become `zedi`, and you can do:
```sh
zedi load "${HOME}/darkside.sh"
```
#### `zed init`
Initialize
#### `zed load`
Load plugin
#### `zed done`
Finalize
#### `zed list`
List plugin-ids
#### `zed pull [plugin-id]`
Pull latest changes for plugins
#### `zed pull-self`
Pull latest changes for zed itself
## Alternatives
_(In alphabetical order of repository names)_
- [zsh-users/antigen](https://github.com/zsh-users/antigen)
- [ohmyzsh/ohmyzsh](https://github.com/ohmyzsh/ohmyzsh)
- [sorin-ionescu/prezto](https://github.com/sorin-ionescu/prezto)
- [mattmc3/pz](https://github.com/mattmc3/pz)
- [agkozak/zcomet](https://github.com/agkozak/zcomet)
- [tarjoilija/zgen](https://github.com/tarjoilija/zgen)
- [jandamm/zgenom](https://github.com/jandamm/zgenom)
- [zimfw/zimfw](https://github.com/zimfw/zimfw)
- [zplug/zplug](https://github.com/zplug/zplug)
- [zpm-zsh/zpm](https://github.com/zpm-zsh/zpm)
- [...more](https://github.com/unixorn/awesome-zsh-plugins#frameworks)
## FAQ
- _**Q**: There are so many zsh plugin managers! Why should I care about this one?_
_**A**:_ You probably shouldn't.
- _**Q**: What does this this offer that the others don't?_
_**A**:_ Well, possibly nothing.
- _**Q**: What does this do differently?_
_**A**:_ It doesn't really matter.
- _**Q**: Why does this freaking exist?_
_**A**:_ Because, it does.
## License
Licensed under the MIT License. Check the [LICENSE](./LICENSE) file for details.