The zimfw plugin manager installs your modules at ${ZIM_HOME}/modules, and
builds a static script at ${ZIM_HOME}/init.zsh that will initialize them. Your
modules are defined in your ~/.zimrc file.
The ~/.zimrc file must contain zmodule calls to define the modules to be
initialized. The initialization will be done in the same order it's defined.
The ~/.zimrc file is not sourced during Zsh startup, and it's only used to
configure the zimfw plugin manager.
Check examples of ~/.zimrc files in the installation page.
zmodule
Below are some usage examples:
- A module from the @zimfw organization:
zmodule archive - A module from another GitHub organization:
zmodule StackExchange/blackbox - A module with a custom URL:
zmodule https://gitlab.com/Spriithy/basher.git - A module at an absolute path, that is already installed:
zmodule /usr/local/share/zsh-autosuggestions - A module with a custom fpath:
zmodule zsh-users/zsh-completions --fpath src - A module with a custom initialization file, and with git submodules disabled:
zmodule spaceship-prompt/spaceship-prompt --source spaceship.zsh --no-submodulesorzmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules - A module with two custom initialization files:
zmodule sindresorhus/pure --source async.zsh --source pure.zsh. Separate zmodule calls can also be used. In this equivalent example, the second call automatically discovers the second file to be sourced:zmodule sindresorhus/pure --source async.zsh zmodule sindresorhus/pure - A module with a custom initialization command:
zmodule skywind3000/z.lua --cmd 'eval "$(lua {}/z.lua --init zsh enhanced once)"' - A module with an on-pull command. It can be used to create a cached initialization script:
zmodule skywind3000/z.lua --on-pull 'lua z.lua --init zsh enhanced once >! init.zsh' - A module with a big git repository:
zmodule romkatv/powerlevel10k --use degit - A module with a custom root subdirectory:
zmodule ohmyzsh/ohmyzsh --root plugins/vim-interaction - A module with multiple roots:
orzmodule sorin-ionescu/prezto --root modules/command-not-found zmodule sorin-ionescu/prezto --root modules/gnu-utilityzmodule ohmyzsh/ohmyzsh --root plugins/perl zmodule ohmyzsh/ohmyzsh --root plugins/vim-interaction
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. Default: the last component in <url>.
Slashes can be used inside the name to organize the module into
subdirectories. The module will be installed at
${ZIM_HOME}/<module_name>.
-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:
--if <test> Will only initialize module root if specified test returns a zero
exit status. The test is evaluated at every new terminal startup.
--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|<name>.(zsh|plugin.zsh|zsh-theme|sh)), if any.
<name> in the glob is resolved to the last component of the mod-
ule name, or the last component of the path to the module root.
-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? Runzimfw install. - Removed modules from
~/.zimrc? Runzimfw uninstall. - Want to update your modules to their latest revisions? Run
zimfw update. - Want to upgrade
zimfwto its latest version? Runzimfw upgrade.
Usage: zimfw <action> [-q|-v]
Actions:
build Build ${ZIM_HOME}/init.zsh and ${ZIM_HOME}/login_init.zsh.
Also does check-dumpfile and compile. Use -v to also see their output.
check-dumpfile Does clean-dumpfile if new completion configuration needs to be dumped.
clean Clean all. Does both clean-compiled and clean-dumpfile.
clean-compiled Clean Zsh compiled files.
clean-dumpfile Clean completion dumpfile.
compile Compile Zsh files.
help Print this help.
info Print Zim and system info.
list List all modules currently defined in ~/.zimrc. Use -v to also see the mod-
ules details.
init Same as install, but with output tailored to be used at terminal startup.
install Install new modules. Also does build, check-dumpfile and compile. Use -v to
also see their output, any on-pull output, and see skipped modules.
uninstall Delete unused modules. Prompts for confirmation. Use -q for quiet uninstall.
update Update current modules. Also does build, check-dumpfile and compile. Use -v
to also see their output, any on-pull output, and see skipped modules.
upgrade Upgrade zimfw. Also does compile. Use -v to also see its output.
version Print zimfw version.
Options:
-q Quiet (yes to prompts, and only outputs errors)
-v Verbose (outputs more details)