Commands

zimfw

The command line utility for Zim:

  • 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> [-q|-v]

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 dump file.
  compile         Compile Zsh files.
  help            Print this help.
  info            Print Zim and system info.
  list            List all modules currently defined in ~/.zimrc. Use -v to also see the mod-
                  ules details.
  init            Same as install, but with output tailored to be used at terminal startup.
  install         Install new modules. Also does build and compile. Use -v to also see their
                  output, and see skipped modules.
  uninstall       Delete unused modules. Prompts for confirmation. Use -q for quiet uninstall.
  update          Update current modules. Also does build and compile. Use -v to also see
                  their output, and see skipped modules.
  upgrade         Upgrade zimfw. Also does compile. Use -v to also see its output.
  version         Print zimfw version.

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

zmodule

Called within your ~/.zimrc to define the modules to be initialized. The modules are initialized in the same order they are defined.

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: zmodule spaceship-prompt/spaceship-prompt --source spaceship.zsh or zmodule spaceship-prompt/spaceship-prompt --name spaceship
  • 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
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.
  -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 file with largest size and 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.