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 init.zsh and login_init.zsh
  clean           Clean all (see below)
  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
  install         Install new modules
  uninstall       Delete unused modules
  update          Update current modules
  upgrade         Upgrade zimfw.zsh
  version         Print Zim version

Options:
  -q              Quiet, only outputs errors
  -v              Verbose

zmodule

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

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

Add zmodule calls to your /var/home/michael/.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: name, zimfw/name, https://github.com/zimfw/name.git.
  -n|--name <module_name>        Set a custom module name. Default: the last component in the <url>.

Repository options:
  -b|--branch <branch_name>      Use specified branch when installing and updating the module.
                                 Overrides the tag option. Default: master.
  -t|--tag <tag_name>            Use specified tag when installing and updating the module.
                                 Overrides the branch option.
  -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 <function_name>  Autoload specified function. Default: all valid names inside the
                                 module's specified fpath paths.
  -s|--source <file_path>        Source specified file. The file path is relative to the module root
                                 directory. Default: the file with largest size matching
                                 {init.zsh,module_name.{zsh,plugin.zsh,zsh-theme,sh}}, if any exist.
  -c|--cmd <command>             Execute specified command. Occurrences of the {} placeholder in the
                                 command are substituted by the module root directory path.
                                 -s 'script.zsh' and -c 'source {}/script.zsh' are equivalent.
  -d|--disabled                  Don't initialize or uninstall the module.