Skip to content
Ben Klein edited this page Mar 11, 2019 · 4 revisions

ZINC Wiki Home

Here you can find information about using and extending ZINC.

If you're looking for a specific segment's documentation, you should check the in-repo docs.

Getting Started / Installing

Installation should be very easy, using a plugin manager makes it even easier.

If you don't have a plugin manager, I'd recommend any of the following:

ZINC does not depend on any other library, Oh-My-Zsh or Prezto are not required.

Zplugin

zplugin ice nocompletions # zinc has no need for completion symlinking
zplugin load robobenklein/zinc

If you don't care for Zplugin's tracking and advanced heuristics, loading the plugin with zplugin light robobenklein/zinc may give better startup times.

If you're on a system with a very slow disk or network-mounted storage, ZINC can be loaded with Zplugin's turbo mode:

PROMPT=" loading > "
zplugin ice nocompletions wait'!0' \
  atload'prompt_zinc_render_to_vars;zle .reset-prompt'
zplugin load robobenklein/zinc

This delays loading ZINC until just after the rest of the shell starts up. If you're on a system with an SSD or ZINC is in memory cache, you might not notice the difference.

Antigen

antigen bundle https://gitlab.com/robobenklein/zinc
# OR
antigen bundle robobenklein/zinc

Without a plugin manager

Clone the ZINC repo somewhere locally and then source zinc.zsh in your .zshrc.

git clone https://gitlab.com/robobenklein/zinc ~/.zinc
echo "source ~/.zinc/zinc.zsh" >> ~/.zshrc