https://github.com/zdharma-continuum/zinit-annex-submods
https://github.com/zdharma-continuum/zinit-annex-submods
zinit zinit-annex zsh
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zdharma-continuum/zinit-annex-submods
- Owner: zdharma-continuum
- License: other
- Created: 2021-11-07T10:39:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-04T10:38:51.000Z (over 1 year ago)
- Last Synced: 2025-03-24T02:21:56.522Z (3 months ago)
- Topics: zinit, zinit-annex, zsh
- Language: Shell
- Homepage:
- Size: 62.5 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zinit-annex-submods
An annex (i.e., an extension for [Zinit](https://github.com/zdharma-continuum/zinit) –
[more information](https://zdharma-continuum.github.io/zinit/wiki/Annexes/)) that allows Zinit to clone additional
submodules when installing a plugin or snippet. The submodules are then automatically updated on the `zinit update ...`
command.
## Installation
Load as a plugin that installs the annex within Zinit:
```zsh
zinit light zinit-zsh/zinit-annex-submods
```
After this, you can use the `submods` ice.
## Usage
### Syntax
```zsh
submods'{user}/{plugin} -> {output directory}'
```
### Example of the `submods` ice
```zsh
# Load the `zsh-autosuggestions' plugin via `autosuggestions' Prezto module
zinit ice svn submods'zsh-users/zsh-autosuggestions -> external'
zinit snippet PZTM::autosuggestions
```
### Example of the `submods` ice and `for` syntax
```zsh
# Load the `zsh-autosuggestions' plugin via `autosuggestions' Prezto module
zi submods'zsh-users/zsh-autosuggestions -> external' for PZTM::autosuggestions
# Load the`zsh-history-substring-search' plugin via Oh-My-Zsh `history-substring-search' plugin
zi submods"zsh-users/zsh-history-substring-search -> external" svn for OMZP::history-substring-search
# Load the`zsh-completions' plugin via Oh-My-Zsh `completion' lib
zi submods"zsh-users/zsh-completions -> external" for OMZL::completion.zsh
```