mirror of synced 2024-11-22 15:25:34 -05:00

ZIM - Zsh IMproved FrameWork

zsh

Find a file

Eric Nielsen dfe35e1bfa Generate static init.zsh script \o/ to autoloads the functions and sources the scripts, instead of executing zimfw during startup, and having it always figuring out what do to on the fly. This takes out the worry about zimfw interfering with the startup time, and allows room to add more features to it. So, zstyle was replaced by a custom zmodule function to define the modules, with the extra ability of allowing users to set custom fpath paths, autoloaded functions and sourced scripts per module.		2020-01-02 12:58:01 -05:00
.github	Update to new repo URL	2018-01-03 10:30:12 -05:00
src	Generate static init.zsh script \o/	2020-01-02 12:58:01 -05:00
.gitignore	Ignore *.zwc.old files when compiling functions	2017-11-24 19:08:39 -05:00
LICENSE.md	use markdown MIT license	2016-02-18 00:04:06 -05:00
Makefile	Zim script in a single file \o/	2020-01-02 12:58:01 -05:00
README.md	Generate static init.zsh script \o/	2020-01-02 12:58:01 -05:00
zimfw.zsh	Generate static init.zsh script \o/	2020-01-02 12:58:01 -05:00

README.md

Zsh IMproved FrameWork

What is Zim?

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

Zim is very easy to customize, and comes with a rich set of modules and features without compromising on speed or functionality!

What does Zim offer?

If you're here, it means you want to see the cool shit Zim can do. Check out the available modules!

Below is a brief showcase of Zim's features.

Speed

For a speed comparison between Zim and other frameworks, see this wiki entry.

Themes

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

Syntax highlighting

And much more!

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

Installation

Installing Zim is easy:

With curl:

curl -fsSL https://raw.githubusercontent.com/zimfw/install/develop/install.zsh | zsh

With wget:

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

Open a new terminal and you're done! Enjoy your Zsh IMproved! Take some time to read about the available modules and tweak your .zshrc file.

If you have a different shell framework installed (like oh-my-zsh or prezto), uninstall those first to prevent conflicts.

Usage

zmodule

Add zmodule calls to your .zimrc file to define the modules to be loaded. The modules are loaded in the same order they are defined. Add:

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

where <url> is the required repository URL or path. The following formats are equivalent: name, zimfw/name, https://github.com/zimfw/name.git

By default, the module name is the last component in the <url>. Use the -n|--name <module_name> option to set a custom module name.

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

Startup 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 all the module 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 exists
-d|--disabled: Don't use or clean the module

zimfw

To install new defined modules, run:

zimfw install

To update your modules, run:

zimfw update

To upgrade Zim, run:

zimfw upgrade

For more information about the zimfw tool, run zimfw with no parameters.

Uninstalling

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