Commands

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
  

Usage: zmodule <url> [-n|--name <module_name>] [-r|--root <path>] [options]

Add zmodule calls to your ~/.zimrc file to define the modules to be initialized. The initiali-
zation will be done in the same order it's defined.

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

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

  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.

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.

Usage: zimfw <action> [option]

Actions:
  build               Build ${ZIM_HOME}/init.zsh and ${ZIM_HOME}/login_init.zsh.
                      Also does compile. Use -v to also see its output.
  clean               Clean all. Does both clean-compiled and clean-dumpfile.
  clean-compiled      Clean Zsh compiled files.
  clean-dumpfile      Clean completion dumpfile.
  compile             Compile Zsh files.
  info                Print zimfw and system info.
  list                List all modules defined in ${_zconfig}.
                      Use -v to also see their initialization details.
  init                Same as install, but with output tailored for the terminal startup.
  install             Install new modules. Also does build, compile. Use -v to also see their
                      output, any on-pull output and skipped modules.
  update              Update current modules. Also does build, compile. Use -v to also see
                      their output, any on-pull output and skipped modules.
  reinstall           Reinstall modules that failed check. Prompts for confirmation, unless -q
                      is used. Also does build, compile. Use -v to also see their output, any
                      on-pull output and skipped modules.
  uninstall           Delete unused modules. Prompts for confirmation, unless -q is used.
  check               Check if updates for current modules are available. Use -v to also see
                      skipped and up to date modules.
  check-version       Check if a new version of zimfw is available.
  upgrade             Upgrade zimfw. Also does compile. Use -v to also see its output.
  help,    --help     Print this help.
  version, --version  Print zimfw version.

Options:
  -q                  Quiet (yes to prompts and only output errors)
  -v                  Verbose (output more details)