2015-12-17 07:44:19 -05:00
< div align = "center" >
2018-01-01 07:58:41 -05:00
< a href = "https://github.com/zimfw/zimfw" >
2021-01-14 09:29:16 -05:00
< img width = "600" src = "https://zimfw.github.io/images/zimfw-banner@2.jpg" >
2015-12-17 07:44:19 -05:00
< / a >
< / div >
2022-02-10 12:04:26 -05:00
< p align = "center" >
< a href = "https://github.com/zimfw/zimfw/releases" > < img src = "https://img.shields.io/github/v/release/zimfw/zimfw" > < / a >
< a href = "https://github.com/zimfw/zimfw/issues" > < img src = "https://img.shields.io/github/issues/zimfw/zimfw.svg" > < / a >
< a href = "https://img.shields.io/github/forks/zimfw/zimfw.svg" > < img src = "https://img.shields.io/github/forks/zimfw/zimfw.svg" > < / a >
< a href = "https://github.com/zimfw/zimfw/stargazers" > < img src = "https://img.shields.io/github/stars/zimfw/zimfw.svg" > < / a >
< a href = "https://github.com/zimfw/zimfw/releases" > < img src = "https://img.shields.io/github/downloads/zimfw/zimfw/total.svg" > < / a >
< a href = "https://github.com/zimfw/zimfw/discussions" > < img src = "https://img.shields.io/badge/forum-online-green.svg" > < / a >
< a href = "https://repology.org/metapackage/rofi/versions" > < img src = "https://repology.org/badge/tiny-repos/rofi.svg" > < / a >
< a href = "https://github.com/zimfw/zimfw/blob/master/LICENSE" > < img alt = "GitHub" src = "https://img.shields.io/github/license/zimfw/zimfw" > < / a >
< / p >
2015-12-15 00:12:17 -05:00
What is Zim?
------------
2019-01-22 19:40:43 -05:00
Zim is a Zsh configuration framework with [blazing speed] and modular extensions.
2015-12-17 08:06:26 -05:00
2021-08-08 21:44:37 -04:00
Zim bundles useful [modules], a wide variety of [themes], and plenty of
customizability without compromising on speed.
2015-12-15 00:12:17 -05:00
What does Zim offer?
2021-08-08 21:44:37 -04:00
--------------------
2015-12-16 18:00:14 -05:00
Below is a brief showcase of Zim's features.
2015-12-15 00:12:17 -05:00
2015-12-18 13:41:02 -05:00
### Speed
2021-08-08 21:44:37 -04:00
< a href = "https://github.com/zimfw/zimfw/wiki/Speed" >
< img src = "https://zimfw.github.io/images/results.svg" >
< / a >
2015-12-18 13:34:24 -05:00
2021-08-08 21:44:37 -04:00
For more details, see [this wiki entry][blazing speed].
2015-12-18 11:44:57 -05:00
2022-02-10 12:04:26 -05:00
## Table of Contents
- [Features ](#features )
+ [Modules ](#modules )
+ [Themes ](#themes )
+ [Degit ](#degit )
- [Installation ](#installation )
+ [Automatic installation ](#automatic-installation )
+ [Manual installation ](#manual-installation )
- [Usage ](#usage )
+ [Example Configuration ](#example-configuration )
- [Settings ](#settings )
+ [`zmodule` ](#zmodule )
+ [`zimfw` ](#zimfw )
- [Uninstalling ](#uninstalling )
- [FAQ ](#faq )
+ [How can I change default `zimrc` file location? ](#how-can-i-change-default-zimrc-file-location )
+ [How can I speed up module installation? ](#how-can-i-speed-up-module-installation )
+ [How to disabel automatic updates? ](#how-to-disabel-automatic-updates )
+ [When should I call `compinit` in my `zshrc` ? ](#when-should-i-call-compinit-in-my-zshrc )
Features
--------
2021-08-08 21:44:37 -04:00
### Modules
2015-12-18 11:44:57 -05:00
2021-08-08 21:44:37 -04:00
Zim has many [modules available][modules]. Enable as many or as few as you'd like.
2015-12-15 00:12:17 -05:00
2021-08-08 21:44:37 -04:00
### Themes
2015-12-15 00:12:17 -05:00
2021-08-08 21:44:37 -04:00
To preview some of the available themes, check the [themes page][themes].
2015-12-15 00:12:17 -05:00
2021-08-10 11:38:01 -04:00
### Degit
Install modules without requiring `git` using our degit tool. It's faster and
2021-11-06 18:04:47 -04:00
lighter than `git` . See the [zmodule ](#zmodule-usage ) usage below.
2021-08-10 11:38:01 -04:00
2015-12-15 00:12:17 -05:00
Installation
------------
2022-02-10 12:04:26 -05:00
Installing Zim is easy. You can choose either of the two methods below:
### Automatic installation
2015-12-15 00:12:17 -05:00
2021-11-15 19:37:40 -05:00
* With curl:
2019-01-22 19:40:43 -05:00
2021-11-15 19:37:40 -05:00
curl -fsSL https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
2019-01-22 19:40:43 -05:00
2021-11-15 19:37:40 -05:00
* With wget:
2019-01-22 19:40:43 -05:00
2021-11-15 19:37:40 -05:00
wget -nv -O - https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
2015-12-15 00:12:17 -05:00
2021-07-01 18:58:49 -04:00
Open a new terminal and you're done. Enjoy your Zsh IMproved! Take some time to
2021-08-08 21:44:37 -04:00
tweak your `~/.zshrc` file, and to also check the available [modules] and [themes]
2021-07-01 18:58:49 -04:00
you can add to your `~/.zimrc` .
2015-12-15 00:12:17 -05:00
2021-07-01 18:58:49 -04:00
< details >
< summary > Prefer to install manually?< / summary >
Add a plugin mechanism \o/
This is a major change, where Zsh modules/plugins are not git submodules
in the Zim repo anymore, but customized and installed separately as
individual repositories. The discussion about this started more than 2
years ago in #88. Closes #299.
This will allow contributors' modules to live in their own repositories.
See #33, #138, #262, #281, #324.
The current code has what, up to this point, I considered to be the best
balance between simplicity, execution speed and number of files.
One measured decision was to make the initialization of modules depend
only on the `':zim' modules` style, keeping it as fast as possible.
The `':zim:module' module` style is used to install, update and clean
the modules, all operations that happen after the user got his
as-blazing-fast-possible shell prompt.
Even though I didn't care much about making install or update fast,
`xargs` has a nice feature of allowing commands to be executed in
parallel with `-P`. I took advantage of that.
I've also worked on making the `zimfw` utility give the user some nice
(while still minimalistic) output. Also I'm suggesting this as the new
name for the `zmanage` tool, since `zimfw` does not shadow the `zim`
wiki tool.
2019-01-07 18:25:34 -05:00
2019-12-04 07:22:17 -05:00
### Manual installation
2020-06-11 22:13:55 -04:00
1. Set Zsh as the default shell:
2019-12-04 07:22:17 -05:00
2020-06-11 22:13:55 -04:00
chsh -s $(which zsh)
2019-12-04 07:22:17 -05:00
2021-07-01 18:58:49 -04:00
2. Prepend the lines in the following templates to the respective dot files:
2021-11-15 19:37:40 -05:00
2021-07-01 18:58:49 -04:00
* [~/.zshrc ](https://raw.githubusercontent.com/zimfw/install/master/src/templates/zshrc )
* [~/.zimrc ](https://raw.githubusercontent.com/zimfw/install/master/src/templates/zimrc )
2019-12-04 07:22:17 -05:00
2021-11-15 19:37:40 -05:00
3. Restart your terminal to automatically install the `zimfw` command line utility,
install the modules defined in `~/.zimrc` , and build the initialization scripts.
2021-07-01 18:58:49 -04:00
< / details >
2019-12-01 16:00:47 -05:00
Usage
-----
2016-09-05 18:36:44 -04:00
2022-02-10 12:04:26 -05:00
By default, zim looks for the configuration file in `${ZIM_HOME}/.zimrc` . The `ZIM_HOME` environment variable is set to `$ZDOTDIR/zim` by default or set to `$HOME` if `$ZDOTDIR` is not found.
Add `zmodule` calls to your `${ZIM_HOME}/.zimrc` or `~/.zimrc` file to define the modules to be
2021-11-06 18:04:47 -04:00
initialized, then run `zimfw install` to install them.
2022-02-10 12:04:26 -05:00
### Example configuration
Example configuration file with [zsh-completions ](https://github.com/zsh-users/zsh-completions ), [autosuggestions ](https://github.com/zsh-users/zsh-autosuggestions ) and [syntax highlighting ](https://github.com/zsh-users/zsh-syntax-highlighting ) plugins installation:
```zsh
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 ](https://zimfw.sh/docs/ ). This provides more convenience when using plugins with completions.
Settings
--------
Below are brief description about some of the zim components
2019-12-01 16:00:47 -05:00
### zmodule
2016-09-05 18:36:44 -04:00
2021-11-08 20:27:14 -05:00
Below are some usage examples:
2022-01-10 20:41:50 -05:00
* A module from the [@zimfw] organization: `zmodule archive`
2021-11-08 20:27:14 -05:00
* 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`
2022-01-25 09:32:50 -05:00
* A module with a custom initialization file, and with git submodules disabled:
`zmodule spaceship-prompt/spaceship-prompt --source spaceship.zsh --no-submodules` or
`zmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules`
2021-11-08 20:27:14 -05:00
* A module with two custom initialization files:
`zmodule sindresorhus/pure --source async.zsh --source pure.zsh`
2022-01-10 20:41:50 -05:00
* A module with a custom initialization command:
`zmodule skywind3000/z.lua --cmd 'eval "$(lua {}/z.lua --init zsh enhanced once)"'`
2021-11-08 20:27:14 -05:00
* A module with a big git repository: `zmodule romkatv/powerlevel10k --use degit`
2021-11-06 18:04:47 -04:00
< details id = "zmodule-usage" >
< summary > Want help with the complete < code > zmodule< / code > usage?< / summary >
2021-08-10 11:38:01 -04:00
< pre > Usage: < b > zmodule< / b > < url> [< b > -n< / b > |< b > --name< / b > < module_name> ] [options]
2016-09-05 18:36:44 -04:00
2021-11-08 20:05:32 -05:00
Add < b > zmodule< / b > calls to your < b > ~/.zimrc< / b > file to define the modules to be initialized. The modules
are initialized in the same order they are defined.
2016-09-05 18:36:44 -04:00
2020-10-11 13:24:01 -04:00
< url> Module absolute path or repository URL. The following URL formats
2021-11-08 20:05:32 -05:00
are equivalent: < b > foo< / b > , < b > zimfw/foo< / b > , < b > https://github.com/zimfw/foo.git< / b > .
< b > -n< / b > |< b > --name< / b > < 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.
Add a plugin mechanism \o/
This is a major change, where Zsh modules/plugins are not git submodules
in the Zim repo anymore, but customized and installed separately as
individual repositories. The discussion about this started more than 2
years ago in #88. Closes #299.
This will allow contributors' modules to live in their own repositories.
See #33, #138, #262, #281, #324.
The current code has what, up to this point, I considered to be the best
balance between simplicity, execution speed and number of files.
One measured decision was to make the initialization of modules depend
only on the `':zim' modules` style, keeping it as fast as possible.
The `':zim:module' module` style is used to install, update and clean
the modules, all operations that happen after the user got his
as-blazing-fast-possible shell prompt.
Even though I didn't care much about making install or update fast,
`xargs` has a nice feature of allowing commands to be executed in
parallel with `-P`. I took advantage of that.
I've also worked on making the `zimfw` utility give the user some nice
(while still minimalistic) output. Also I'm suggesting this as the new
name for the `zmanage` tool, since `zimfw` does not shadow the `zim`
wiki tool.
2019-01-07 18:25:34 -05:00
2020-01-15 12:35:30 -05:00
Repository options:
2021-08-10 11:38:01 -04:00
< b > -b< / b > |< b > --branch< / b > < branch_name> Use specified branch when installing and updating the module.
2021-11-08 20:05:32 -05:00
Overrides the tag option. Default: the repository default branch.
< b > -t< / b > |< b > --tag< / b > < tag_name> Use specified tag when installing and updating the module. Over-
rides the branch option.
2021-08-10 11:38:01 -04:00
< b > -u< / b > |< b > --use< / b > < < b > git< / b > |< b > degit< / b > > Install and update the module using the defined tool. Default is
2021-11-08 20:05:32 -05:00
either defined by < b > zstyle ' :zim:zmodule' use ' < / b > < < b > git< / b > |< b > degit< / b > > < b > ' < / b > , or < b > git< / b >
if none is provided.
< b > git< / b > requires git itself. Local changes are preserved on updates.
2021-08-10 11:38:01 -04:00
< b > degit< / b > requires curl or wget, and currently only works with GitHub
2021-11-08 20:05:32 -05:00
URLs. Modules install faster and take less disk space. Local
changes are lost on updates. Git submodules are not supported.
2022-01-25 09:32:50 -05:00
< b > --no-submodules< / b > Don' t install or update git submodules.
2021-08-10 11:38:01 -04:00
< b > -z< / b > |< b > --frozen< / b > Don' t install or update the module.
Add a plugin mechanism \o/
This is a major change, where Zsh modules/plugins are not git submodules
in the Zim repo anymore, but customized and installed separately as
individual repositories. The discussion about this started more than 2
years ago in #88. Closes #299.
This will allow contributors' modules to live in their own repositories.
See #33, #138, #262, #281, #324.
The current code has what, up to this point, I considered to be the best
balance between simplicity, execution speed and number of files.
One measured decision was to make the initialization of modules depend
only on the `':zim' modules` style, keeping it as fast as possible.
The `':zim:module' module` style is used to install, update and clean
the modules, all operations that happen after the user got his
as-blazing-fast-possible shell prompt.
Even though I didn't care much about making install or update fast,
`xargs` has a nice feature of allowing commands to be executed in
parallel with `-P`. I took advantage of that.
I've also worked on making the `zimfw` utility give the user some nice
(while still minimalistic) output. Also I'm suggesting this as the new
name for the `zmanage` tool, since `zimfw` does not shadow the `zim`
wiki tool.
2019-01-07 18:25:34 -05:00
2020-01-15 12:35:30 -05:00
Initialization options:
2021-08-10 11:38:01 -04:00
< b > -f< / b > |< b > --fpath< / b > < path> Add specified path to fpath. The path is relative to the module
root directory. Default: < b > functions< / b > , if the subdirectory exists.
< b > -a< / b > |< b > --autoload< / b > < func_name> Autoload specified function. Default: all valid names inside the
2021-11-15 19:37:40 -05:00
< b > functions< / b > subdirectory, if any.
2021-11-08 20:05:32 -05:00
< b > -s< / b > |< b > --source< / b > < file_path> Source specified file. The file path is relative to the module
root directory. Default: < b > init.zsh< / b > , if the < b > functions< / b > subdirectory
2022-01-25 09:32:50 -05:00
also exists, or the largest of the files with name matching
2021-11-08 20:05:32 -05:00
< b > {init.zsh,module_name.{zsh,plugin.zsh,zsh-theme,sh}}< / b > , if any.
< b > -c< / b > |< b > --cmd< / b > < command> Execute specified command. Occurrences of the < b > {}< / b > placeholder in
the command are substituted by the module root directory path.
I.e., < b > -s ' foo.zsh' < / b > and < b > -c ' source {}/foo.zsh' < / b > are equivalent.
2021-08-10 11:38:01 -04:00
< b > -d< / b > |< b > --disabled< / b > Don' t initialize or uninstall the module.
2021-11-06 18:04:47 -04:00
2021-11-08 20:05:32 -05:00
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.
2020-05-02 19:47:38 -04:00
< / pre >
Add a plugin mechanism \o/
This is a major change, where Zsh modules/plugins are not git submodules
in the Zim repo anymore, but customized and installed separately as
individual repositories. The discussion about this started more than 2
years ago in #88. Closes #299.
This will allow contributors' modules to live in their own repositories.
See #33, #138, #262, #281, #324.
The current code has what, up to this point, I considered to be the best
balance between simplicity, execution speed and number of files.
One measured decision was to make the initialization of modules depend
only on the `':zim' modules` style, keeping it as fast as possible.
The `':zim:module' module` style is used to install, update and clean
the modules, all operations that happen after the user got his
as-blazing-fast-possible shell prompt.
Even though I didn't care much about making install or update fast,
`xargs` has a nice feature of allowing commands to be executed in
parallel with `-P`. I took advantage of that.
I've also worked on making the `zimfw` utility give the user some nice
(while still minimalistic) output. Also I'm suggesting this as the new
name for the `zmanage` tool, since `zimfw` does not shadow the `zim`
wiki tool.
2019-01-07 18:25:34 -05:00
2021-11-06 18:04:47 -04:00
< / details >
2019-12-01 16:00:47 -05:00
### zimfw
2016-09-05 18:36:44 -04:00
2021-11-08 20:27:14 -05:00
The command line utility for Zim:
2019-12-07 21:17:40 -05:00
2021-11-08 20:27:14 -05:00
* 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` utility, run `zimfw help` .
Add a plugin mechanism \o/
This is a major change, where Zsh modules/plugins are not git submodules
in the Zim repo anymore, but customized and installed separately as
individual repositories. The discussion about this started more than 2
years ago in #88. Closes #299.
This will allow contributors' modules to live in their own repositories.
See #33, #138, #262, #281, #324.
The current code has what, up to this point, I considered to be the best
balance between simplicity, execution speed and number of files.
One measured decision was to make the initialization of modules depend
only on the `':zim' modules` style, keeping it as fast as possible.
The `':zim:module' module` style is used to install, update and clean
the modules, all operations that happen after the user got his
as-blazing-fast-possible shell prompt.
Even though I didn't care much about making install or update fast,
`xargs` has a nice feature of allowing commands to be executed in
parallel with `-P`. I took advantage of that.
I've also worked on making the `zimfw` utility give the user some nice
(while still minimalistic) output. Also I'm suggesting this as the new
name for the `zmanage` tool, since `zimfw` does not shadow the `zim`
wiki tool.
2019-01-07 18:25:34 -05:00
2022-02-10 12:04:26 -05:00
FAQ
----
### 1. How can I change default `zimrc` file location?
The location of `.zimrc` file is controlled by `ZIM_HOME` environment variable. Change it to the desired path.
Eg: Set this in your `zshrc` to change path of `zimrc` to `~/.config/zsh/zim` :
`export ZIM_HOME="${HOME}/.config/zsh/zim"`
### 2. How can I speed up module installation?
Add a plugin mechanism \o/
This is a major change, where Zsh modules/plugins are not git submodules
in the Zim repo anymore, but customized and installed separately as
individual repositories. The discussion about this started more than 2
years ago in #88. Closes #299.
This will allow contributors' modules to live in their own repositories.
See #33, #138, #262, #281, #324.
The current code has what, up to this point, I considered to be the best
balance between simplicity, execution speed and number of files.
One measured decision was to make the initialization of modules depend
only on the `':zim' modules` style, keeping it as fast as possible.
The `':zim:module' module` style is used to install, update and clean
the modules, all operations that happen after the user got his
as-blazing-fast-possible shell prompt.
Even though I didn't care much about making install or update fast,
`xargs` has a nice feature of allowing commands to be executed in
parallel with `-P`. I took advantage of that.
I've also worked on making the `zimfw` utility give the user some nice
(while still minimalistic) output. Also I'm suggesting this as the new
name for the `zmanage` tool, since `zimfw` does not shadow the `zim`
wiki tool.
2019-01-07 18:25:34 -05:00
2021-08-10 11:38:01 -04:00
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'
2022-02-10 12:04:26 -05:00
### 3. How to disabel automatic updates?
2020-05-26 09:02:25 -04:00
By default, `zimfw` will check if it has a new version available every 30 days.
2020-01-15 12:35:30 -05:00
This can be disabled with:
Add a plugin mechanism \o/
This is a major change, where Zsh modules/plugins are not git submodules
in the Zim repo anymore, but customized and installed separately as
individual repositories. The discussion about this started more than 2
years ago in #88. Closes #299.
This will allow contributors' modules to live in their own repositories.
See #33, #138, #262, #281, #324.
The current code has what, up to this point, I considered to be the best
balance between simplicity, execution speed and number of files.
One measured decision was to make the initialization of modules depend
only on the `':zim' modules` style, keeping it as fast as possible.
The `':zim:module' module` style is used to install, update and clean
the modules, all operations that happen after the user got his
as-blazing-fast-possible shell prompt.
Even though I didn't care much about making install or update fast,
`xargs` has a nice feature of allowing commands to be executed in
parallel with `-P`. I took advantage of that.
I've also worked on making the `zimfw` utility give the user some nice
(while still minimalistic) output. Also I'm suggesting this as the new
name for the `zmanage` tool, since `zimfw` does not shadow the `zim`
wiki tool.
2019-01-07 18:25:34 -05:00
2020-01-15 12:35:30 -05:00
zstyle ':zim' disable-version-check yes
2022-02-10 12:04:26 -05:00
### 4. When should I call `compinit` in my `zshrc` ?
`compinit` is called by _completions_ module as shown in the [Example configuration ](https://github.com/zimfw/zimfw#example-configuration ). So, if you are using that module then remove any call to `compinit` in your `.zshrc` like:
```sh
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:
```sh
autoload -Uz compinit
compinit
```
before `zmodule ...` calls in your `.zshrc`
Add a plugin mechanism \o/
This is a major change, where Zsh modules/plugins are not git submodules
in the Zim repo anymore, but customized and installed separately as
individual repositories. The discussion about this started more than 2
years ago in #88. Closes #299.
This will allow contributors' modules to live in their own repositories.
See #33, #138, #262, #281, #324.
The current code has what, up to this point, I considered to be the best
balance between simplicity, execution speed and number of files.
One measured decision was to make the initialization of modules depend
only on the `':zim' modules` style, keeping it as fast as possible.
The `':zim:module' module` style is used to install, update and clean
the modules, all operations that happen after the user got his
as-blazing-fast-possible shell prompt.
Even though I didn't care much about making install or update fast,
`xargs` has a nice feature of allowing commands to be executed in
parallel with `-P`. I took advantage of that.
I've also worked on making the `zimfw` utility give the user some nice
(while still minimalistic) output. Also I'm suggesting this as the new
name for the `zmanage` tool, since `zimfw` does not shadow the `zim`
wiki tool.
2019-01-07 18:25:34 -05:00
Uninstalling
------------
The best way to remove Zim is to manually delete `~/.zim` , `~/.zimrc` , and
2019-12-14 22:41:19 -05:00
remove the initialization lines from your `~/.zshenv` , `~/.zshrc` and `~/.zlogin` .
2016-09-05 18:36:44 -04:00
2019-01-22 19:40:43 -05:00
[blazing speed]: https://github.com/zimfw/zimfw/wiki/Speed
2021-07-01 18:58:49 -04:00
[modules]: https://zimfw.sh/docs/modules/
[themes]: https://zimfw.sh/docs/themes/
2022-01-10 20:41:50 -05:00
[@zimfw]: https://github.com/zimfw