{"id":25951922,"url":"https://github.com/Eriner/zim","last_synced_at":"2025-03-04T14:01:18.708Z","repository":{"id":37375151,"uuid":"48021097","full_name":"zimfw/zimfw","owner":"zimfw","description":"Zim: Modular, customizable, and blazing fast Zsh framework","archived":false,"fork":false,"pushed_at":"2025-02-19T19:37:35.000Z","size":962,"stargazers_count":4023,"open_issues_count":25,"forks_count":182,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-02-24T07:46:03.852Z","etag":null,"topics":["framework","zim","zimfw","zsh","zsh-configuration","zsh-plugin-manager"],"latest_commit_sha":null,"homepage":"https://zimfw.sh","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zimfw.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-15T05:13:58.000Z","updated_at":"2025-02-24T01:34:58.000Z","dependencies_parsed_at":"2024-01-06T01:07:17.152Z","dependency_job_id":"606126a5-023b-4465-9762-e87eaacf110c","html_url":"https://github.com/zimfw/zimfw","commit_stats":{"total_commits":681,"total_committers":52,"mean_commits":"13.096153846153847","dds":0.5433186490455213,"last_synced_commit":"e8e26c1b136f4233d2f9d070277e052b96dd7d02"},"previous_names":["eriner/zim"],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zimfw%2Fzimfw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zimfw%2Fzimfw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zimfw%2Fzimfw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zimfw%2Fzimfw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zimfw","download_url":"https://codeload.github.com/zimfw/zimfw/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241860003,"owners_count":20032319,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","zim","zimfw","zsh","zsh-configuration","zsh-plugin-manager"],"created_at":"2025-03-04T14:01:06.357Z","updated_at":"2025-03-04T14:01:18.675Z","avatar_url":"https://github.com/zimfw.png","language":"Shell","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/zimfw/zimfw/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/zimfw/zimfw\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zimfw/zimfw/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/zimfw/zimfw.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zimfw/zimfw/network/members\"\u003e\u003cimg src=\"https://img.shields.io/github/forks/zimfw/zimfw.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zimfw/zimfw/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/zimfw/zimfw.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zimfw/zimfw/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/downloads/zimfw/zimfw/total.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zimfw/zimfw/discussions\"\u003e\u003cimg src=\"https://img.shields.io/badge/forum-online-green.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zimfw/zimfw/blob/master/LICENSE\"\u003e\u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/zimfw/zimfw\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/zimfw/zimfw\"\u003e\n    \u003cimg width=\"600\" src=\"https://zimfw.github.io/images/zimfw-banner@2.jpg\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\nWhat is Zim?\n------------\nZim is a Zsh configuration framework that bundles a [plugin manager](#usage),\nuseful [modules] and a wide variety of [themes], without compromising on [speed].\n\nCheck how Zim compares to other frameworks and plugin managers:\n\n\u003ca href=\"https://github.com/zimfw/zimfw/wiki/Speed\"\u003e\n  \u003cimg src=\"https://zimfw.github.io/images/results.svg\"\u003e\n\u003c/a\u003e\n\nTable of Contents\n-----------------\n* [Installation](#installation)\n  * [Automatic installation](#automatic-installation)\n  * [Homebrew](#homebrew)\n  * [Manual installation](#manual-installation)\n    * [Set up `~/.zshrc`](#set-up-zshrc)\n    * [Create `~/.zimrc`](#create-zimrc)\n* [Usage](#usage)\n  * [`zmodule`](#zmodule)\n  * [`zimfw`](#zimfw)\n* [Settings](#settings)\n* [Uninstalling](#uninstalling)\n\nInstallation\n------------\nInstalling Zim is easy. You can choose either the automatic or manual method below:\n\n### Automatic installation\n\nThis will install a predefined set of modules and a theme for you.\n\n* With `curl`:\n  ```zsh\n  curl -fsSL https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh\n  ```\n\n* With `wget`:\n  ```zsh\n  wget -nv -O - https://raw.githubusercontent.com/zimfw/install/master/install.zsh | zsh\n  ```\n\nRestart your terminal and you're done. Enjoy your Zsh IMproved! Take some time\nto tweak your [`~/.zshrc`](#set-up-zshrc) file and to also check the available\n[modules] and [themes] you can add to your [`~/.zimrc`](#create-zimrc).\n\n### Homebrew\n\n1. Install zimfw with brew:\n    ```zsh\n    brew install --formula zimfw\n    ```\n\n2. Add the following to your `~/.zshrc`:\n   ```zsh\n   ZIM_HOME=~/.zim\n   # Install missing modules and update ${ZIM_HOME}/init.zsh if missing or outdated.\n   if [[ ! ${ZIM_HOME}/init.zsh -nt ${ZIM_CONFIG_FILE:-${ZDOTDIR:-${HOME}}/.zimrc} ]]; then\n     source /path/to/zimfw.zsh init\n   fi\n   # Initialize modules.\n   source ${ZIM_HOME}/init.zsh\n   ```\n   replacing `/path/to/zimfw.zsh` with the path where brew installed the script,\n   which is shown in the brew formula caveats. It is usually:\n   * `/opt/homebrew/opt/zimfw/share/zimfw.zsh` on Apple Silicon macOS,\n   * `/usr/local/opt/zimfw/share/zimfw.zsh` on Intel macOS,\n   * `/home/linuxbrew/.linuxbrew/opt/zimfw/share/zimfw.zsh` on Linux.\n\n3. [Create your `~/.zimrc` file](#create-zimrc)\n\n4. Restart your terminal and you're done. Enjoy your Zsh IMproved!\n\n### Manual installation\n\n1. Set Zsh as the default shell, if you haven't done so already:\n    ```zsh\n    chsh -s $(which zsh)\n    ````\n\n2. [Set up your `~/.zshrc` file](#set-up-zshrc)\n\n3. [Create your `~/.zimrc` file](#create-zimrc)\n\n4. Restart your terminal and you're done. Enjoy your Zsh IMproved!\n\n#### Set up `~/.zshrc`\n\nAdd the lines below to your `~/.zshrc` file, in the following order:\n\n1. To set where the zimfw plugin manager configuration file will be located:\n   ```zsh\n   ZIM_CONFIG_FILE=~/.config/zsh/zimrc\n   ```\n   This is optional. The value of `ZIM_CONFIG_FILE` can be any path your user\n   has at least read access to. By default, the file must be at `~/.zimrc`, if\n   the `ZDOTDIR` environment variable is not defined. Otherwise, it must be at\n   `${ZDOTDIR}/.zimrc`.\n\n2. To set the directory where the zimfw plugin manager will keep necessary files:\n   ```zsh\n   ZIM_HOME=~/.zim\n   ```\n   The value of `ZIM_HOME` can be any directory your user has write access to.\n   You can even set it to a cache directory like `${XDG_CACHE_HOME}/zim` or\n   `~/.cache/zim`.\n\n3. To automatically download the zimfw plugin manager if missing:\n   ```zsh\n   # Download zimfw plugin manager if missing.\n   if [[ ! -e ${ZIM_HOME}/zimfw.zsh ]]; then\n     curl -fsSL --create-dirs -o ${ZIM_HOME}/zimfw.zsh \\\n         https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh\n   fi\n   ```\n   Or if you use `wget` instead of `curl`:\n   ```zsh\n   # Download zimfw plugin manager if missing.\n   if [[ ! -e ${ZIM_HOME}/zimfw.zsh ]]; then\n     mkdir -p ${ZIM_HOME} \u0026\u0026 wget -nv -O ${ZIM_HOME}/zimfw.zsh \\\n         https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh\n   fi\n   ```\n   This is optional. Alternatively, you can download the `zimfw.zsh` script\n   anywhere your user has write access to: just replace the occurrences of\n   `${ZIM_HOME}/zimfw.zsh` by the preferred path, like `/usr/local/share/zimfw/zimfw.zsh`\n   for example. If you choose to not include this step, you should manually\n   download the `zimfw.zsh` script once and keep it at the preferred path.\n\n4. To automatically install missing modules and update the static initialization\n   script if missing or outdated:\n   ```zsh\n   # Install missing modules and update ${ZIM_HOME}/init.zsh if missing or outdated.\n   if [[ ! ${ZIM_HOME}/init.zsh -nt ${ZIM_CONFIG_FILE:-${ZDOTDIR:-${HOME}}/.zimrc} ]]; then\n     source ${ZIM_HOME}/zimfw.zsh init\n   fi\n   ```\n   This step is optional, but highly recommended. If you choose to not include\n   it, you must remember to manually run `zimfw install` every time you update\n   your [`~/.zimrc`](#create-zimrc) file. If you have chosen to keep the\n   `zimfw.zsh` in a different path as mentioned in the previous step, replace\n   `${ZIM_HOME}/zimfw.zsh` by the chosen path.\n\n5. To source the static script, that will initialize your modules:\n   ```zsh\n   # Initialize modules.\n   source ${ZIM_HOME}/init.zsh\n   ```\n\n#### Create `~/.zimrc`\n\nThis file configures the zimfw plugin manager. It's referred to as `~/.zimrc`\nin the documentation for the sake of simplicity, but the actual location of the\nfile is defined by the following rules:\n\n1. You can define the full path and name of the file with a `ZIM_CONFIG_FILE`\n   environment variable. For example:\n   ```zsh\n   ZIM_CONFIG_FILE=~/.config/zsh/zimrc\n   ```\n\n2. Or, if you defined a `ZDOTDIR` environment variable, then the file must be at\n   `${ZDOTDIR}/.zimrc`\n\n3. Otherwise, it must be at at `~/.zimrc`, which is it's default location.\n\nAs for the contents of the file, you can start with just:\n```zsh\n# Fish-like syntax highlighting for Zsh.\nzmodule zsh-users/zsh-syntax-highlighting\n# Fish-like autosuggestions for Zsh.\nzmodule zsh-users/zsh-autosuggestions\n```\n\nIf you also want saner defaults:\n```zsh\n#\n# Modules\n#\n\n# Sets sane Zsh built-in environment options.\nzmodule environment\n# Applies correct bindkeys for input events.\nzmodule input\n# Utility aliases and functions. Adds colour to ls, grep and less.\nzmodule utility\n\n#\n# Modules that must be initialized last\n#\n\n# Fish-like syntax highlighting for Zsh.\nzmodule zsh-users/zsh-syntax-highlighting\n# Fish-like autosuggestions for Zsh.\nzmodule zsh-users/zsh-autosuggestions\n```\n\nIf you also want one of our prompt [themes]:\n```zsh\n#\n# Modules\n#\n\n# Sets sane Zsh built-in environment options.\nzmodule environment\n# Applies correct bindkeys for input events.\nzmodule input\n# Utility aliases and functions. Adds colour to ls, grep and less.\nzmodule utility\n\n#\n# Prompt\n#\n\n# Exposes to prompts how long the last command took to execute, used by asciiship.\nzmodule duration-info\n# Exposes git repository status information to prompts, used by asciiship.\nzmodule git-info\n# A heavily reduced, ASCII-only version of the Spaceship and Starship prompts.\nzmodule asciiship\n\n#\n# Modules that must be initialized last\n#\n\n# Fish-like syntax highlighting for Zsh.\nzmodule zsh-users/zsh-syntax-highlighting\n# Fish-like autosuggestions for Zsh.\nzmodule zsh-users/zsh-autosuggestions\n```\n\nIf you want to use our [completion] module too, instead of using `compinit` directly:\n```zsh\n#\n# Modules\n#\n\n# Sets sane Zsh built-in environment options.\nzmodule environment\n# Applies correct bindkeys for input events.\nzmodule input\n# Utility aliases and functions. Adds colour to ls, grep and less.\nzmodule utility\n\n#\n# Prompt\n#\n\n# Exposes to prompts how long the last command took to execute, used by asciiship.\nzmodule duration-info\n# Exposes git repository status information to prompts, used by asciiship.\nzmodule git-info\n# A heavily reduced, ASCII-only version of the Spaceship and Starship prompts.\nzmodule asciiship\n\n#\n# Completion\n#\n\n# Additional completion definitions for Zsh.\nzmodule zsh-users/zsh-completions --fpath src\n# Enables and configures smart and extensive tab completion.\n# completion must be sourced after all modules that add completion definitions.\nzmodule completion\n\n#\n# Modules that must be initialized last\n#\n\n# Fish-like syntax highlighting for Zsh.\n# zsh-users/zsh-syntax-highlighting must be sourced after completion\nzmodule zsh-users/zsh-syntax-highlighting\n# Fish-like autosuggestions for Zsh.\nzmodule zsh-users/zsh-autosuggestions\n```\n\nThe [completion] module calls `compinit` for you. You should remove any\n`compinit` calls from your `~/.zshrc` when you use this module. The modules will\nbe initialized in the order they are defined, and [completion] must be\ninitialized *after* all modules that add completion definitions, so it must come\nafter [zsh-users/zsh-completions].\n\nCheck the [`zmodule` usage](#zmodule) below for more examples on how to use it to\ndefine the modules you want to use.\n\nUsage\n-----\nThe zimfw plugin manager installs your modules at `${ZIM_HOME}/modules` and\nbuilds a static script at `${ZIM_HOME}/init.zsh` that will initialize them. Your\nmodules are defined in your `~/.zimrc` file.\n\nThe `~/.zimrc` file must contain `zmodule` calls to define the modules to be\ninitialized. The modules will be initialized in the same order they're defined.\n\nThe `~/.zimrc` file is not sourced during Zsh startup and it's only used to\nconfigure the zimfw plugin manager.\n\nCheck [examples of `~/.zimrc` files](#create-zimrc) above.\n\n### zmodule\n\nBelow are some usage examples:\n\n  * A module from the [@zimfw] organization: `zmodule archive`\n  * A module from another GitHub organization: `zmodule StackExchange/blackbox`\n  * A module with a custom URL: `zmodule https://gitlab.com/Spriithy/basher.git`\n  * A module at an absolute path, that is already installed:\n    `zmodule /usr/local/share/zsh-autosuggestions`\n  * A module with a custom fpath: `zmodule zsh-users/zsh-completions --fpath src`\n  * A module with a custom initialization file and with git submodules disabled:\n    `zmodule spaceship-prompt/spaceship-prompt --source spaceship.zsh --no-submodules` or\n    `zmodule spaceship-prompt/spaceship-prompt --name spaceship --no-submodules`\n  * A module with two custom initialization files:\n    `zmodule sindresorhus/pure --source async.zsh --source pure.zsh`. Separate\n    zmodule calls can also be used. In this equivalent example, the second call\n    automatically discovers the second file to be sourced:\n    ```\n    zmodule sindresorhus/pure --source async.zsh\n    zmodule sindresorhus/pure\n    ```\n  * A module with a custom initialization command:\n    `zmodule skywind3000/z.lua --cmd 'eval \"$(lua {}/z.lua --init zsh enhanced once)\"'`\n  * A module with an on-pull command. It can be used to create a cached initialization script:\n    `zmodule skywind3000/z.lua --on-pull 'lua z.lua --init zsh enhanced once \u003e! init.zsh'`\n  * A module with a big git repository: `zmodule romkatv/powerlevel10k --use degit`\n  * A module with a custom root subdirectory: `zmodule ohmyzsh/ohmyzsh --root plugins/vim-interaction`\n  * A module with multiple roots:\n    ```\n    zmodule sorin-ionescu/prezto --root modules/command-not-found\n    zmodule sorin-ionescu/prezto --root modules/gnu-utility\n    ```\n    or\n    ```\n    zmodule ohmyzsh/ohmyzsh --root plugins/perl\n    zmodule ohmyzsh/ohmyzsh --root plugins/vim-interaction\n    ```\n\n\u003cdetails id=\"zmodule-usage\"\u003e\n\u003csummary\u003eWant help with the complete \u003ccode\u003ezmodule\u003c/code\u003e usage?\u003c/summary\u003e\n\n\u003cpre\u003eUsage: \u003cb\u003ezmodule\u003c/b\u003e \u0026lt;url\u0026gt; [\u003cb\u003e-n\u003c/b\u003e|\u003cb\u003e--name\u003c/b\u003e \u0026lt;module_name\u0026gt;] [\u003cb\u003e-r\u003c/b\u003e|\u003cb\u003e--root\u003c/b\u003e \u0026lt;path\u0026gt;] [options]\n\nAdd \u003cb\u003ezmodule\u003c/b\u003e calls to your \u003cb\u003e~/.zimrc\u003c/b\u003e file to define the modules to be initialized. The initiali-\nzation will be done in the same order it\u0026apos;s defined.\n\n  \u0026lt;url\u0026gt;                      Module absolute path or repository URL. The following are equiva-\n                             lent: \u003cb\u003e\u0026apos;foo\u0026apos;\u003c/b\u003e, \u003cb\u003e\u0026apos;zimfw/foo\u0026apos;\u003c/b\u003e, \u003cb\u003e\u0026apos;https://github.com/zimfw/foo.git\u003c/b\u003e\u0026apos;.\n                             If an absolute path is given, the module is considered externally\n                             installed and won\u0026apos;t be installed or updated by zimfw.\n  \u003cb\u003e-n\u003c/b\u003e, \u003cb\u003e--name\u003c/b\u003e \u0026lt;module_name\u0026gt;   Set a custom module name. Default: the last component in \u0026lt;url\u0026gt;.\n                             Slashes can be used inside \u0026lt;module_name\u0026gt; to organize the module\n                             into subdirectories. The module will be installed at\n                             \u003cb\u003e${ZIM_HOME}/\u003c/b\u003e\u0026lt;module_name\u0026gt;.\n  \u003cb\u003e-r\u003c/b\u003e, \u003cb\u003e--root\u003c/b\u003e \u0026lt;path\u0026gt;          Relative path to the module root.\n\nPer-module options:\n  \u003cb\u003e-b\u003c/b\u003e, \u003cb\u003e--branch\u003c/b\u003e \u0026lt;branch_name\u0026gt;\n                             Use specified branch when installing and updating the module.\n                             Overrides the tag option. Default: the repository default branch.\n  \u003cb\u003e-t\u003c/b\u003e, \u003cb\u003e--tag\u003c/b\u003e \u0026lt;tag_name\u0026gt;       Use specified tag when installing and updating the module. Over-\n                             rides the branch option.\n  \u003cb\u003e-u\u003c/b\u003e, \u003cb\u003e--use\u003c/b\u003e \u0026lt;tool_name\u0026gt;      Install and update the module using the defined tool. Default is\n                             either defined using \u003cb\u003ezstyle \u0026apos;:zim:zmodule\u0026apos; use \u0026apos;\u003c/b\u003e\u0026lt;tool_name\u0026gt;\u003cb\u003e\u0026apos;\u003c/b\u003e or\n                             set to \u003cb\u003e\u0026apos;auto\u0026apos;\u003c/b\u003e. The tools available are:\n                             \u003cb\u003e\u0026apos;auto\u0026apos;\u003c/b\u003e tries to auto detect the tool to be used. When installing\n                             a new module, \u003cb\u003e\u0026apos;git\u0026apos;\u003c/b\u003e will be used if the git command is available,\n                             otherwise \u003cb\u003e\u0026apos;degit\u0026apos;\u003c/b\u003e will be used.\n                             \u003cb\u003e\u0026apos;git\u0026apos;\u003c/b\u003e uses the git command. Local changes are preserved on up-\n                             dates.\n                             \u003cb\u003e\u0026apos;degit\u0026apos;\u003c/b\u003e uses curl or wget, and currently only works with GitHub\n                             URLs. Modules install faster and take less disk space. Local\n                             changes are lost on updates. Git submodules are not supported.\n                             \u003cb\u003e\u0026apos;mkdir\u0026apos;\u003c/b\u003e creates an empty directory. The \u0026lt;url\u0026gt; is only used to set\n                             the module name. Use the \u003cb\u003e-c\u003c/b\u003e, \u003cb\u003e--cmd\u003c/b\u003e option or \u003cb\u003e--on-pull\u003c/b\u003e option to\n                             execute the desired command to generate the module files.\n      \u003cb\u003e--no-submodules\u003c/b\u003e        Don\u0026apos;t install or update git submodules.\n  \u003cb\u003e-z\u003c/b\u003e, \u003cb\u003e--frozen\u003c/b\u003e               Don\u0026apos;t install or update the module.\n\n  The per-module options above are carried over multiple zmodule calls for the same module.\n  Modules are uniquely identified by their name.\n\nPer-module-root options:\n      \u003cb\u003e--if\u003c/b\u003e \u0026lt;test\u0026gt;            Will only initialize module root if specified test returns a zero\n                             exit status. The test is evaluated at every new terminal startup.\n      \u003cb\u003e--if-command\u003c/b\u003e \u0026lt;cmd_name\u0026gt;\n                             Will only initialize module root if specified external command is\n                             available. This is evaluated at every new terminal startup.\n                             Equivalent to \u003cb\u003e--if \u0026apos;(( \\${+commands[\u003c/b\u003e\u0026lt;cmd_name\u0026gt;\u003cb\u003e]} ))\u0026apos;\u003c/b\u003e.\n      \u003cb\u003e--if-ostype\u003c/b\u003e \u0026lt;ostype\u0026gt;   Will only initialize module root if \u003cb\u003eOSTYPE\u003c/b\u003e is equal to the given\n                             expression. This is evaluated at every new terminal startup.\n                             Equivalent to \u003cb\u003e--if \u0026apos;[[ \\${OSTYPE} == \u003c/b\u003e\u0026lt;ostype\u0026gt;\u003cb\u003e ]]\u0026apos;\u003c/b\u003e.\n      \u003cb\u003e--on-pull\u003c/b\u003e \u0026lt;command\u0026gt;    Execute command after installing or updating the module. The com-\n                             mand is executed in the module root directory.\n  \u003cb\u003e-d\u003c/b\u003e, \u003cb\u003e--disabled\u003c/b\u003e             Don\u0026apos;t initialize the module root or uninstall the module.\n\n  The per-module-root options above are carried over multiple zmodule calls for the same mod-\n  ule root.\n\nPer-call initialization options:\n  \u003cb\u003e-f\u003c/b\u003e, \u003cb\u003e--fpath\u003c/b\u003e \u0026lt;path\u0026gt;         Will add specified path to fpath. The path is relative to the\n                             module root directory. Default: \u003cb\u003e\u0026apos;functions\u0026apos;\u003c/b\u003e, if the subdirectory\n                             exists and is non-empty.\n  \u003cb\u003e-a\u003c/b\u003e, \u003cb\u003e--autoload\u003c/b\u003e \u0026lt;func_name\u0026gt;\n                             Will autoload specified function. Default: all valid names inside\n                             the \u003cb\u003efunctions\u003c/b\u003e subdirectory, if any.\n  \u003cb\u003e-s\u003c/b\u003e, \u003cb\u003e--source\u003c/b\u003e \u0026lt;file_path\u0026gt;   Will source specified file. The path is relative to the module\n                             root directory. Default: \u003cb\u003e\u0026apos;init.zsh\u0026apos;\u003c/b\u003e, if a non-empty \u003cb\u003efunctions\u003c/b\u003e\n                             subdirectory exists, else the largest of the files matching the\n                             glob \u003cb\u003e(init.zsh|\u003c/b\u003e\u0026lt;name\u0026gt;\u003cb\u003e.(zsh|plugin.zsh|zsh-theme|sh))\u003c/b\u003e, if any. The\n                             \u0026lt;name\u0026gt; in the glob is resolved to the last component of the mod-\n                             ule name and the last component of the path to the module root.\n  \u003cb\u003e-c\u003c/b\u003e, \u003cb\u003e--cmd\u003c/b\u003e \u0026lt;command\u0026gt;        Will execute specified command. Occurrences of the \u003cb\u003e{}\u003c/b\u003e placeholder\n                             in the command are substituted by the module root directory path.\n                             I.e., \u003cb\u003e-s \u0026apos;foo.zsh\u0026apos;\u003c/b\u003e and \u003cb\u003e-c \u0026apos;source {}/foo.zsh\u0026apos;\u003c/b\u003e are equivalent.\n\n  Setting any per-call initialization option above will disable the default values from the\n  other per-call initialization options, so only your provided values will be used. I.e. these\n  values are either all automatic or all manual in each zmodule call. To use default values\n  and also provided values, use separate zmodule calls.\n\u003c/pre\u003e\n\n\u003c/details\u003e\n\n### zimfw\n\nThe Zim plugin manager:\n\n  * Added new modules to `~/.zimrc`? Run `zimfw install`.\n  * Removed modules from `~/.zimrc`? Run `zimfw uninstall`.\n  * Want to update your modules to their latest revisions? Run `zimfw update`.\n  * Want to upgrade zimfw to its latest version? Run `zimfw upgrade`.\n  * For more information about the zimfw plugin manager, run `zimfw --help`.\n\nSettings\n--------\nSet the path of the directory used by zimfw with the `ZIM_HOME` environment\nvariable:\n\n    ZIM_HOME=~/.zim\n\nBy default, the zimfw plugin manager configuration file must be at `~/.zimrc`,\nif the `ZDOTDIR` environment variable is not defined. Otherwise, it must be at\n`${ZDOTDIR}/.zimrc`. You can customize its full path and name with the\n`ZIM_CONFIG_FILE` environment variable:\n\n    ZIM_CONFIG_FILE=~/.config/zsh/zimrc\n\nThe zimfw plugin manager will detect if `git` is installed and fall back to work without `git`\nwith its degit tool. If you want to take advantage of its degit tool regardless for faster and\nlighter module installations, you can set degit as the default tool with:\n\n    zstyle ':zim:zmodule' use 'degit'\n\nBy default, zimfw will check if it has a new version available every 30 days. If\nthe `zimfw.zsh` file cannot be upgraded, because your user does not have write\naccess to it, then this will be disabled. This can be manually disabled with:\n\n    zstyle ':zim' disable-version-check yes\n\nBy default, zimfw will disable color output when executed through a pipe or as a\nnon-TTY ssh command. To force disabling color output, prefix the zimfw call with\n`NO_COLOR=1`, like:\n\n    NO_COLOR=1 zimfw install\n\nor add the following to your `.zshrc`, which should also disable color output\nfor other tools. See https://no-color.org/\n\n    export NO_COLOR=1\n\nUninstalling\n------------\nThe best way to remove Zim is to manually delete `~/.zim`, `~/.zimrc`, and\nremove the initialization lines from your `~/.zshenv`, `~/.zshrc` and `~/.zlogin`.\n\n[modules]: https://zimfw.sh/docs/modules/\n[themes]: https://zimfw.sh/docs/themes/\n[speed]: https://github.com/zimfw/zimfw/wiki/Speed\n[@zimfw]: https://github.com/zimfw\n[completion]: https://github.com/zimfw/completion\n[zsh-users/zsh-completions]: https://github.com/zsh-users/zsh-completions\n","funding_links":[],"categories":["Shells"],"sub_categories":["ZSH"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEriner%2Fzim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEriner%2Fzim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEriner%2Fzim/lists"}