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

ZIM - Zsh IMproved FrameWork

zsh

Find a file

Eric Nielsen f7c0bbeb36 Prefer the prezto module format to avoid conflicts when we have Zim modules made to also be compatible with ohmyzsh, like https://github.com/zimfw/pvenv We don't want to be affected by the noise a `${module_name}.plugin.zsh` file creates, as we always want to source `init.zsh` when a module also has a `functions` subdir. Hope this better protects us from the "wild west out there".		2021-03-16 17:04:40 -05:00
.github	Update ISSUE_TEMPLATE.md	2020-01-07 11:34:17 -05:00
src	Prefer the prezto module format	2021-03-16 17:04:40 -05:00
.gitignore	Update .gitignore and Makefile	2020-01-16 12:19:22 -05:00
CHANGELOG.md	Prefer the prezto module format	2021-03-16 17:04:40 -05:00
CODE_OF_CONDUCT.md	Add CODE_OF_CONDUCT.md	2020-01-20 07:43:40 -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 with website links	2021-02-15 17:32:36 -05:00
zimfw.zsh	Prefer the prezto module format	2021-03-16 17:04:40 -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 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/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 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.

Manual installation

Set Zsh as the default shell:
```
chsh -s $(which zsh)
```
Add the lines in the following templates to the respective dot files:
- ~/.zshenv
- ~/.zshrc
- ~/.zlogin
- ~/.zimrc
Copy https://github.com/zimfw/zimfw/releases/latest/download/zimfw.zsh to ~/.zim/zimfw.zsh.
Install the modules defined in ~/.zimrc and build the initialization scripts:
```
zsh ~/.zim/zimfw.zsh install
```

Usage

zmodule

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: 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: the repository's default branch.
  -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 <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: 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.

zimfw

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 tool, run zimfw help.

Settings

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.