Want help with the complete zmodule
usage?
Usage: zmodule <url> [-n|--name <module_name>] [-r|--root <path>] [options]
Add zmodule calls to your ~/.zimrc file to define the modules to be initialized. The initiali-
zation will be done in the same order it's defined.
<url> Module absolute path or repository URL. The following URL formats
are equivalent: foo, zimfw/foo, https://github.com/zimfw/foo.git.
If an absolute path is given, the module is considered externally
installed, and won't be installed or updated by zimfw.
-n|--name <module_name> Set a custom module name. Use slashes inside the name to organize
the module into subdirectories. The module will be installed at
${ZIM_HOME}/<module_name>. Default: the last component in <url>.
-r|--root <path> Relative path to the module root.
Per-module options:
-b|--branch <branch_name> Use specified branch when installing and updating the module.
Overrides the tag option. Default: the repository default branch.
-t|--tag <tag_name> Use specified tag when installing and updating the module. Over-
rides the branch option.
-u|--use <git|degit> Install and update the module using the defined tool. Default is
either defined by zstyle ':zim:zmodule' use '<git|degit>', or git
if none is provided.
git requires git itself. Local changes are preserved on updates.
degit requires curl or wget, and currently only works with GitHub
URLs. Modules install faster and take less disk space. Local
changes are lost on updates. Git submodules are not supported.
--no-submodules Don't install or update git submodules.
-z|--frozen Don't install or update the module.
The per-module options above are carried over multiple zmodule calls for the same module.
Modules are uniquely identified by their name.
Per-module-root options:
--on-pull <command> Execute command after installing or updating the module. The com-
mand is executed in the module root directory.
-d|--disabled Don't initialize the module root or uninstall the module.
The per-module-root options above are carried over multiple zmodule calls for the same mod-
ule root.
Per-call initialization options:
-f|--fpath <path> Will add specified path to fpath. The path is relative to the
module root directory. Default: functions, if the subdirectory
exists and is non-empty.
-a|--autoload <func_name> Will autoload specified function. Default: all valid names inside
the functions subdirectory, if any.
-s|--source <file_path> Will source specified file. The path is relative to the module
root directory. Default: init.zsh, if a non-empty functions sub-
directory exists, else the largest of the files matching the glob
(init.zsh|<root_tail>.(zsh|plugin.zsh|zsh-theme|sh)), if any.
-c|--cmd <command> Will execute specified command. Occurrences of the {} placeholder
in the command are substituted by the module root directory path.
I.e., -s 'foo.zsh' and -c 'source {}/foo.zsh' are equivalent.
Setting any per-call initialization option above will disable the default values from the
other per-call initialization options, so only your provided values will be used. I.e. these
values are either all automatic, or all manual in each zmodule call. To use default values
and also provided values, use separate zmodule calls.
### zimfw
The Zim plugin manager:
* Added new modules to `~/.zimrc`? Run `zimfw install`.
* Removed modules from `~/.zimrc`? Run `zimfw uninstall`.
* Want to update your modules to their latest revisions? Run `zimfw update`.
* Want to upgrade `zimfw` to its latest version? Run `zimfw upgrade`.
* For more information about the `zimfw` plugin manager, run `zimfw help`.
Settings
--------
Modules are installed using `git` by default. If you don't have `git`
installed, or if you want to take advantage of our degit tool for faster and
lighter module installations, you can set degit as the default tool with:
zstyle ':zim:zmodule' use 'degit'
By default, `zimfw` will check if it has a new version available every 30 days.
This can be disabled with:
zstyle ':zim' disable-version-check yes
Uninstalling
------------
The best way to remove Zim is to manually delete `~/.zim`, `~/.zimrc`, and
remove the initialization lines from your `~/.zshenv`, `~/.zshrc` and `~/.zlogin`.
[modules]: https://zimfw.sh/docs/modules/
[themes]: https://zimfw.sh/docs/themes/
[speed]: https://github.com/zimfw/zimfw/wiki/Speed
[@zimfw]: https://github.com/zimfw
[completion]: https://github.com/zimfw/completion
[zsh-users/zsh-completions]: https://github.com/zsh-users/zsh-completions