<div align="center">
  <a href="https://zimfw.sh" target="_blank">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://zimfw.github.io/images/logo-dark.svg"/>
      <source media="(prefers-color-scheme: light)" srcset="https://zimfw.github.io/images/logo.svg"/>
      <img alt="Zim Framework logo" src="https://zimfw.github.io/images/logo.svg"/>
    </picture>
  </a>
</div>

<p align="center">
  <a href="https://zimfw.sh" target="_blank">Zim Framework</a>:
  The Zsh configuration framework with blazing speed and modular extensions.
</p>

<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://github.com/zimfw/zimfw/network/members"><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://github.com/zimfw/zimfw/blob/master/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/zimfw/zimfw"></a>
</p>

<hr/>

Zim Framework is a Zsh configuration framework that bundles a [plugin manager](#usage),
useful [modules] and a wide variety of [themes], without compromising on [speed].

Check how Zim Framework compares to other frameworks and plugin managers:

<a href="https://github.com/zimfw/zimfw/wiki/Speed">
  <img src="https://zimfw.github.io/images/results.svg">
</a>

Table of Contents
-----------------
* [Installation](#installation)
  * [Automatic installation](#automatic-installation)
  * [Homebrew](#homebrew)
  * [Manual installation](#manual-installation)
    * [Set up `~/.zshrc`](#set-up-zshrc)
* [Usage](#usage)
  * [`zmodule`](#zmodule)
  * [`zimfw`](#zimfw)
* [Settings](#settings)
* [Uninstalling](#uninstalling)

Installation
------------
Installing Zim Framework is easy. You can choose either the automatic or manual
method below:

### Automatic installation

This will install a predefined set of modules and a theme for you.

* With `curl`:
  ```zsh
  curl -fsSL https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
  ```

* With `wget`:
  ```zsh
  wget -nv -O - https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh
  ```

Restart your terminal and you're done. Enjoy your Zsh IMproved! Take some time
to tweak your [`~/.zshrc`](#set-up-zshrc) file and to also check the available
[modules] and [themes] you can add to your `~/.zimrc`.

### Homebrew

1. Install zimfw with brew:
    ```zsh
    brew install --formula zimfw
    ```

2. Add the following to your `~/.zshrc`:
   ```zsh
   ZIM_HOME=${ZDOTDIR:-${HOME}}/.zim
   # Install missing modules and update ${ZIM_HOME}/init.zsh if missing or outdated.
   if [[ ! ${ZIM_HOME}/init.zsh -nt ${ZIM_CONFIG_FILE:-${ZDOTDIR:-${HOME}}/.zimrc} ]]; then
     source /path/to/zimfw.zsh init
   fi
   # Initialize modules.
   source ${ZIM_HOME}/init.zsh
   ```
   replacing `/path/to/zimfw.zsh` with the path where brew installed the script,
   which is shown in the brew formula caveats. It is usually:
   * `/opt/homebrew/opt/zimfw/share/zimfw.zsh` on Apple Silicon macOS,
   * `/usr/local/opt/zimfw/share/zimfw.zsh` on Intel macOS,
   * `/home/linuxbrew/.linuxbrew/opt/zimfw/share/zimfw.zsh` on Linux.

3. Restart your terminal and you're done. Enjoy your Zsh IMproved!

### Manual installation

1. Set Zsh as the default shell, if you haven't done so already:
    ```zsh
    chsh -s $(which zsh)
    ```

2. [Set up your `~/.zshrc` file](#set-up-zshrc)

3. Restart your terminal and you're done. Enjoy your Zsh IMproved!

#### Set up `~/.zshrc`

Add the lines below to your `~/.zshrc` file, in the following order:

1. To set where the zimfw plugin manager configuration file will be located:
   ```zsh
   ZIM_CONFIG_FILE=~/.config/zsh/zimrc
   ```
   This is optional. The value of `ZIM_CONFIG_FILE` can be any path your user
   has at least read access to. By default, the file must be at `~/.zimrc`, if
   the `ZDOTDIR` environment variable is not defined. Otherwise, it must be at
   `${ZDOTDIR}/.zimrc`.

2. To set the directory where the zimfw plugin manager will keep necessary files:
   ```zsh
   ZIM_HOME=${ZDOTDIR:-${HOME}}/.zim
   ```
   The value of `ZIM_HOME` can be any directory your user has write access to.
   You can even set it to a cache directory like `${XDG_CACHE_HOME}/zim` or
   `~/.cache/zim`.

3. To automatically download the zimfw plugin manager if missing:
   ```zsh
   # 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
   ```
   Or if you use `wget` instead of `curl`:
   ```zsh
   # 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
   ```
   This is optional. Alternatively, the `zimfw.zsh` script can be installed with
   a package manager or downloaded anywhere your user has write access to: just
   replace the occurrences of `${ZIM_HOME}/zimfw.zsh` by the preferred path,
   like `/usr/local/share/zimfw/zimfw.zsh` for example. If you choose to not
   include this step, you should install or manually download the `zimfw.zsh`
   script once and keep it at the preferred path.

4. To automatically install missing modules and update the static initialization
   script if missing or outdated:
   ```zsh
   # Install missing modules and update ${ZIM_HOME}/init.zsh if missing or outdated.
   if [[ ! ${ZIM_HOME}/init.zsh -nt ${ZIM_CONFIG_FILE:-${ZDOTDIR:-${HOME}}/.zimrc} ]]; then
     source ${ZIM_HOME}/zimfw.zsh init
   fi
   ```
   This step is optional, but highly recommended. If you choose to not include
   it, you must remember to manually run `zimfw install` every time you update
   your `~/.zimrc` file. If you have chosen to keep the `zimfw.zsh` script in a
   different path as mentioned in the previous step, replace
   `${ZIM_HOME}/zimfw.zsh` by the chosen path.

5. To source the static script, that will initialize your modules:
   ```zsh
   # Initialize modules.
   source ${ZIM_HOME}/init.zsh
   ```

Usage
-----
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 modules will be initialized in the same order they're defined.

The `~/.zimrc` file is not sourced during Zsh startup and it's only used to
configure the zimfw plugin manager.

### 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` or
    `zmodule 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:
    ```
    zmodule sorin-ionescu/prezto --root modules/command-not-found
    zmodule sorin-ionescu/prezto --root modules/gnu-utility
    ```
    or
    ```
    zmodule ohmyzsh/ohmyzsh --root plugins/perl
    zmodule ohmyzsh/ohmyzsh --root plugins/vim-interaction
    ```

<details id="zmodule-usage">
<summary>Want help with the complete <code>zmodule</code> usage?</summary>

<pre>Usage: <b>zmodule</b> &lt;url&gt; [<b>-n</b>|<b>--name</b> &lt;module_name&gt;] [<b>-r</b>|<b>--root</b> &lt;path&gt;] [options]

Add <b>zmodule</b> calls to your <b>~/.zimrc</b> file to define the modules to be initialized. The initiali-
zation will be done in the same order it&apos;s defined.

  &lt;url&gt;                      Module absolute path or repository URL. The following are equiva-
                             lent: <b>&apos;foo&apos;</b>, <b>&apos;zimfw/foo&apos;</b>, <b>&apos;https://github.com/zimfw/foo.git</b>&apos;.
                             If an absolute path is given, the module is considered externally
                             installed and won&apos;t be installed or updated by zimfw.
  <b>-n</b>, <b>--name</b> &lt;module_name&gt;   Set a custom module name. Default: the last component in &lt;url&gt;.
                             Slashes can be used inside &lt;module_name&gt; to organize the module
                             into subdirectories. The module will be installed at
                             <b>${ZIM_HOME}/</b>&lt;module_name&gt;.
  <b>-r</b>, <b>--root</b> &lt;path&gt;          Relative path to the module root.

Per-module options:
  <b>-b</b>, <b>--branch</b> &lt;branch_name&gt;
                             Use specified branch when installing and updating the module.
                             Overrides the tag option. Default: the repository default branch.
  <b>-t</b>, <b>--tag</b> &lt;tag_name&gt;       Use specified tag when installing and updating the module. Over-
                             rides the branch option.
  <b>-u</b>, <b>--use</b> &lt;tool_name&gt;      Install and update the module using the defined tool. Default is
                             either defined using <b>zstyle &apos;:zim:zmodule&apos; use &apos;</b>&lt;tool_name&gt;<b>&apos;</b> or
                             set to <b>&apos;auto&apos;</b>. The tools available are:
                             <b>&apos;auto&apos;</b> tries to auto detect the tool to be used. When installing
                             a new module, <b>&apos;git&apos;</b> will be used if the git command is available,
                             otherwise <b>&apos;degit&apos;</b> will be used.
                             <b>&apos;git&apos;</b> uses the git command. Local changes are preserved on up-
                             dates.
                             <b>&apos;degit&apos;</b> uses 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.
                             <b>&apos;mkdir&apos;</b> creates an empty directory. The &lt;url&gt; is only used to set
                             the module name. Use the <b>-c</b>, <b>--cmd</b> option or <b>--on-pull</b> option to
                             execute the desired command to generate the module files.
      <b>--no-submodules</b>        Don&apos;t install or update git submodules.
  <b>-z</b>, <b>--frozen</b>               Don&apos;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:
      <b>--if</b> &lt;test&gt;            Will only initialize module root if specified test returns a zero
                             exit status. The test is evaluated at every new terminal startup.
      <b>--if-command</b> &lt;command_name&gt;
                             Will only initialize module root if specified external command is
                             available. This is evaluated at every new terminal startup.
                             Equivalent to <b>--if &apos;(( \${+commands[</b>&lt;command_name&gt;<b>]} ))&apos;</b>.
      <b>--if-ostype</b> &lt;ostype&gt;   Will only initialize module root if <b>OSTYPE</b> is equal to the given
                             expression. This is evaluated at every new terminal startup.
                             Equivalent to <b>--if &apos;[[ \${OSTYPE} == </b>&lt;ostype&gt;<b> ]]&apos;</b>.
      <b>--on-pull</b> &lt;command&gt;    Execute command after installing or updating the module. The com-
                             mand is executed in the module root directory.
  <b>-d</b>, <b>--disabled</b>             Don&apos;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:
  <b>-f</b>, <b>--fpath</b> &lt;path&gt;         Will add specified path to fpath. The path is relative to the
                             module root directory. Default: <b>&apos;functions&apos;</b>, if the subdirectory
                             exists and is non-empty.
  <b>-a</b>, <b>--autoload</b> &lt;function_name&gt;
                             Will autoload specified function. Default: all valid names inside
                             the <b>functions</b> subdirectory, if any.
  <b>-s</b>, <b>--source</b> &lt;file_path&gt;   Will source specified file. The path is relative to the module
                             root directory. Default: <b>&apos;init.zsh&apos;</b>, if a non-empty <b>functions</b>
                             subdirectory exists, else the largest of the files matching the
                             glob <b>(init.zsh|</b>&lt;name&gt;<b>.(zsh|plugin.zsh|zsh-theme|sh))</b>, if any. The
                             &lt;name&gt; in the glob is resolved to the last component of the mod-
                             ule name and the last component of the path to the module root.
  <b>-c</b>, <b>--cmd</b> &lt;command&gt;        Will execute specified command. Occurrences of the <b>{}</b> placeholder
                             in the command are substituted by the module root directory path.
                             I.e., <b>-s &apos;foo.zsh&apos;</b> and <b>-c &apos;source {}/foo.zsh&apos;</b> 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.
</pre>

</details>

### zimfw

The Zim Framework 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
--------
Set the path of the directory used by zimfw with the `ZIM_HOME` environment
variable:

    ZIM_HOME=${ZDOTDIR:-${HOME}}/.zim

By default, the zimfw plugin manager configuration file must be at `~/.zimrc`,
if the `ZDOTDIR` environment variable is not defined. Otherwise, it must be at
`${ZDOTDIR}/.zimrc`. You can customize its full path and name with the
`ZIM_CONFIG_FILE` environment variable:

    ZIM_CONFIG_FILE=~/.config/zsh/zimrc

The zimfw plugin manager will detect if `git` is installed and fall back to work
without `git` with its degit tool. If you want to take advantage of its degit
tool regardless 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. If
the `zimfw.zsh` file cannot be upgraded, because your user does not have write
access to it, then this will be disabled. This can be manually disabled with:

    zstyle ':zim' disable-version-check yes

By default, zimfw will disable color output when executed through a pipe or as a
non-TTY ssh command. To force disabling color output, prefix the zimfw call with
`NO_COLOR=1`, like:

    NO_COLOR=1 zimfw install

or add the following to your `.zshrc`, which should also disable color output
for other tools. See https://no-color.org/

    export NO_COLOR=1

Uninstalling
------------
The best way to remove Zim Framework 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
