The module is a binary Zsh module (think about zmodload Zsh command, it's that topic) which transparently and automatically compiles sourced scripts. Many plugin managers do not offer compilation of plugins, the module is a solution to this. Even if a plugin manager does compile plugin's main script (like Zi does).
Install just the standalone binary which can be used with any other plugin manager.
Note This script can be used with most plugin managers and Zi is not required.
sh <(curl -fsSL https://raw.githubusercontent.com/z-shell/zpmod/main/Scripts/install.sh)
This script will display what to add to ~/.zshrc (2 lines) and show usage instructions.
You can also clone the repository and use the included build.sh script with various configuration options:
git clone https://github.com/z-shell/zpmod.git cd zpmod ./build.sh [OPTIONS]
The build script supports these options:
Option Description--target=DIR, --target DIR Install to a specific directory --clean Run make distclean instead of make clean --quiet, -q Suppress non-essential output --verbose, -v Show more detailed build information --no-git Skip git clone/pull operations --force, -f Force rebuild even if Makefile exists --build-only Build but don't update .zshrc --cflags="..." Pass custom CFLAGS to configure (default: -g -Wall -Wextra -O3) --branch=NAME Use specific git branch (default: main) --zsh-path=PATH Use specific Zsh executable --jobs=N, -jN Set number of parallel make jobs --prefix=DIR Set installation prefix (for system installs) --no-install Skip installation after building --help, -h Show help message
# Install to a custom directory ./build.sh --target=/opt/zsh-modules/zpmod # Build with specific compiler optimizations ./build.sh --cflags="-O3 -march=native" # System installation sudo ./build.sh --prefix=/usr/local # Quiet installation with 8 parallel jobs ./build.sh --quiet --jobs=8 # Development build from a specific branch ./build.sh --branch=develop --verbose
Note Zi users can build the module by issuing the following command instead of running the above installation scripts.
This command will compile the module and display instructions on what to add to ~/.zshrc.
After installation, add these lines at the top of your ~/.zshrc:
# Adjust the path if you installed to a custom location
module_path+=( "${HOME}/.zi/zmodules/zpmod/Src" )
zmodload zi/zpmod Measuring Time of Sources
Besides the compilation-feature, the module also measures duration of each script sourcing. Issue zpmod source-study after loading the module at top of ~/.zshrc to see a list of all sourced files with the time the sourcing took in milliseconds on the left. This feature allows you to profile the shell startup. Also, no script can pass through that check and you will obtain a complete list of all loaded scripts, like if Zshell itself was investigating this. The list can be surprising.
To enable debug messages from the module set:
typeset -g ZI_MOD_DEBUG=1
--no-git)If you encounter build issues:
--verbose to see detailed build outputmake.log file in the build directory--clean to perform a fresh buildRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4