0acf84e297 | ||
---|---|---|
src | ||
.gitignore | ||
CHANGELOG.md | ||
LICENSE | ||
Makefile | ||
README.md | ||
zimfw.zsh |
README.md
What is Zim?
Zim is a Zsh configuration framework with blazing speed and modular extensions.
Zim bundles a plugin manager, useful modules, and a wide variety of themes, without compromising on speed.
See how it compares to other frameworks and plugin managers:
Table of Contents
Installation
Installing Zim is easy. You can choose either the manual or automatic method below:
Manual installation
-
Set Zsh as the default shell, if you haven't done so already:
chsh -s $(which zsh)
-
If you don't have
git
installed, first add this line to your.zshrc
file (yes, Zim works even withoutgit
!):zstyle ':zim:zmodule' use 'degit'
-
Add these lines to your
~/.zshrc
:ZIM_HOME=${ZDOTDIR:-${HOME}}/.zim # Download zimfw plugin manager if missing. if [[ ! -e ${ZIM_HOME}/zimfw.zsh ]]; then curl -fsSL --create-dirs -o ${ZIM_HOME}/zimfw.zsh \ https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh fi # Install missing plugins, and update ${ZIM_HOME}/init.zsh if missing or outdated. if [[ ! ${ZIM_HOME}/init.zsh -nt ${ZDOTDIR:-${HOME}}/.zimrc ]]; then source ${ZIM_HOME}/zimfw.zsh init -q fi # Initialize plugins. source ${ZIM_HOME}/init.zsh
Or if you use
wget
instead ofcurl
:ZIM_HOME=${ZDOTDIR:-${HOME}}/.zim # Download zimfw plugin manager if missing. if [[ ! -e ${ZIM_HOME}/zimfw.zsh ]]; then mkdir -p ${ZIM_HOME} && wget -nv -O ${ZIM_HOME}/zimfw.zsh \ https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh fi # Install missing plugins, and update ${ZIM_HOME}/init.zsh if missing or outdated. if [[ ! ${ZIM_HOME}/init.zsh -nt ${ZDOTDIR:-${HOME}}/.zimrc ]]; then source ${ZIM_HOME}/zimfw.zsh init -q fi # Initialize plugins. source ${ZIM_HOME}/init.zsh
-
Create a
~/.zimrc
file, and add azmodule
call for each plugin you want to use. The~/.zimrc
file is not sourced during the Zsh startup, and it's only used to configure thezimfw
plugin manager.See the
zmodule
usage below.For example, you can start with just:
zmodule zsh-users/zsh-syntax-highlighting zmodule zsh-users/zsh-autosuggestions
Or if you also want to use completions:
zmodule zsh-users/zsh-completions zmodule completion zmodule zsh-users/zsh-syntax-highlighting zmodule zsh-users/zsh-autosuggestions
The
zmodule completion
is a Zim module that callscompinit
for you. So no need to havecompinit
in your~/.zshrc
when you use this module.Check the available modules and themes you can add to your
~/.zimrc
. -
Restart your terminal to automatically download the
zimfw
plugin manager, install the plugins defined in~/.zimrc
, and initialize them. Enjoy your Zsh IMproved!
Automatic installation
This will install a predefined set of modules and a theme.
-
With curl:
curl -fsSL https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
-
With wget:
wget -nv -O - https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
Open a new terminal and you're done. Enjoy your Zsh IMproved! Take some time to
tweak your ~/.zshrc
file, and to also check the available modules and themes
you can add to your ~/.zimrc
.
Usage
By default, Zim looks for the configuration file in {ZDOTDIR:-${HOME}}/.zimrc
. If using the automatic installer, the ZIM_HOME
environment variable is set to ${ZDOTDIR:-${HOME}}/.zim
.
Add zmodule
calls to your {ZDOTDIR:-${HOME}}/.zimrc
file to define the modules to be
initialized, then run zimfw install
to install them.
Example configuration
Example configuration file with zsh-completions, autosuggestions and syntax highlighting plugins installation:
zmodule completions
zmodule zsh-users/zsh-completions
zmodule zsh-users/zsh-autosuggestions
zmodule zsh-users/zsh-syntax-highlighting
The first line is to install module named completions as can be seen from the modules section in Docs. This provides more convenience when using plugins with completions.
Settings
Below are brief description about some of the Zim components
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-submodules
orzmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules
- A module with two custom initialization files:
zmodule sindresorhus/pure --source async.zsh --source pure.zsh
- A module with a custom initialization command:
zmodule skywind3000/z.lua --cmd 'eval "$(lua {}/z.lua --init zsh enhanced once)"'
- A module with a big git repository:
zmodule romkatv/powerlevel10k --use degit
Want help with the complete zmodule
usage?
Usage: zmodule <url> [-n|--name <module_name>] [options] Add zmodule calls to your ~/.zimrc file to define the modules to be initialized. The modules are initialized in the same order they are defined. <url> Module absolute path or repository URL. The following URL formats are equivalent: foo, zimfw/foo, https://github.com/zimfw/foo.git. -n|--name <module_name> Set a custom module name. Default: the last component in <url>. Use slashes inside the name to organize the module into subdirec- tories. Repository 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. Initialization options: -f|--fpath <path> Add specified path to fpath. The path is relative to the module root directory. Default: functions, if the subdirectory exists. -a|--autoload <func_name> Autoload specified function. Default: all valid names inside the functions subdirectory, if any. -s|--source <file_path> Source specified file. The file path is relative to the module root directory. Default: init.zsh, if the functions subdirectory also exists, or the largest of the files with name matching {init.zsh,module_name.{zsh,plugin.zsh,zsh-theme,sh}}, if any. -c|--cmd <command> 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. -d|--disabled Don't initialize or uninstall the module. Setting any initialization option above will disable all the default values from the other initialization options, so only your provided values are used. I.e. these values are either all automatic, or all manual.
zimfw
The command line utility for Zim:
- 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
zimfw
to its latest version? Runzimfw upgrade
. - For more information about the
zimfw
utility, runzimfw help
.
FAQ
1. How can I change default zimrc
file location?
You cannot change the default .zimrc location, it must be in {ZDOTDIR:-
{HOME}}/.zimrc. You can change the ZDOTDIR
location. Change it to the desired path.
Eg: Set this in your ~/.zshenv
to change path of zimrc
to ~/.config/zsh/.zimrc
:
export ZDOTDIR="${HOME}/.config/zsh"
2. How can I speed up module installation?
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'
3. How to disabel automatic updates?
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
4. When should I call compinit
in my zshrc
?
compinit
is called by completions module as shown in the Example configuration. So, if you are using that module then remove any call to compinit
in your .zshrc
like:
autoload -Uz compinit
compinit
# End of lines added by compinstall
which maybe present after fresh install of zsh or anywhere in your system-wide zsh files like /etc/zsh/zshrc
which comes with some installations using distro package manager. Otherwise, add:
autoload -Uz compinit
compinit
before zmodule ...
calls in your .zshrc
Uninstalling
The best way to remove Zim is to manually delete ~/.zim
, ~/.zimrc
, and
remove the initialization lines from your ~/.zshenv
, ~/.zshrc
and ~/.zlogin
.