ZIM - Zsh IMproved FrameWork
zsh
Go to file
Eric Nielsen 6e7c6a269d
Update README.md formatting
to be closer to the one used in https://zimfw.sh/docs/commands/
2021-11-08 20:27:14 -05:00
src Narrow zmodule help text again 2021-11-08 20:05:32 -05:00
.gitignore Update .gitignore and Makefile 2020-01-16 12:19:22 -05:00
CHANGELOG.md v1.6.1 2021-11-08 12:03:49 -05:00
LICENSE Update LICENSE 2021-01-04 21:17:02 -05:00
Makefile Update .gitignore and Makefile 2020-01-16 12:19:22 -05:00
README.md Update README.md formatting 2021-11-08 20:27:14 -05:00
zimfw.zsh Narrow zmodule help text again 2021-11-08 20:05:32 -05:00

README.md

What is Zim?

Zim is a Zsh configuration framework with blazing speed and modular extensions.

Zim bundles useful modules, a wide variety of themes, and plenty of customizability without compromising on speed.

What does Zim offer?

Below is a brief showcase of Zim's features.

Speed

For more details, see this wiki entry.

Modules

Zim has many modules available. Enable as many or as few as you'd like.

Themes

To preview some of the available themes, check the themes page.

Degit

Install modules without requiring git using our degit tool. It's faster and lighter than git. See the zmodule usage below.

Installation

Installing Zim is easy:

  • With curl:

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

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

Open a new terminal and you're done. Enjoy your Zsh IMproved! Take some time to tweak your ~/.zshrc file, and to also check the available modules and themes you can add to your ~/.zimrc.

Prefer to install manually?

Manual installation

  1. Set Zsh as the default shell:

    chsh -s $(which zsh)
    
  2. Prepend the lines in the following templates to the respective dot files:

  3. Restart your terminal to automatically install the modules defined in ~/.zimrc and build the initialization scripts.

Usage

Add zmodule calls to your ~/.zimrc file to define the modules to be initialized, then run zimfw install to install them.

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 name: 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 custom initialization commands: zmodule skywind3000/z.lua --cmd 'export _ZL_HYPHEN=1' --cmd 'eval "$(lua {}/z.lua --init zsh enhanced once)"'
  • A module with a big git repository: zmodule romkatv/powerlevel10k --use degit
Want help with the complete zmodule usage?
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
                             module's specified fpath paths.
  -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.

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.
  • For more information about the zimfw utility, run zimfw help.

Settings

Modules are installed using git by default. If you don't have git installed, or if you want to take advantage of our degit tool 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. This can be disabled with:

zstyle ':zim' disable-version-check yes

Uninstalling

The best way to remove Zim is to manually delete ~/.zim, ~/.zimrc, and remove the initialization lines from your ~/.zshenv, ~/.zshrc and ~/.zlogin.