Skip to content

Installation

Package

Homebrew

zsh-abbr is available on Homebrew. Run

shell
brew install olets/tap/zsh-abbr

and follow the post-install instructions logged to the terminal.

TIP

brew upgrade will upgrade you to the latest version, even if it's a major version change.

Want to stay on this major version until you choose to upgrade to the next? When installing zsh-abbr with Homebrew for the first time, run

shell
brew install olets/tap/zsh-abbr@6

If you've already installed olets/tap/zsh-abbr with Homebrew, you can switch to the v6 formula by running

shell
brew uninstall --force zsh-abbr && brew install olets/tap/zsh-abbr@6

Linux package repositories

WARNING

These may lag behind the official release channels.

Community members have created packages in some Linux distros' package repositories. These include

There may be others out there. If you know of another, please make a pull request to this page!

Plugin

You can install zsh-abbr with a zsh plugin manager, including those built into frameworks such as Oh-My-Zsh (OMZ) and prezto. Each has their own way of doing things. Read your package manager's documentation or the zsh plugin manager plugin installation procedures gist; Fig users can install zsh-abbr from its page in the Fig plugin directory

TIP

Want to stay on this major version until you choose to upgrade to the next? Use your package manager's convention for specifying the branch v6.

After adding the plugin to the manager, it will be available in all new terminals. To use it in an already-open terminal, restart zsh in that terminal:

shell
exec zsh

Manual

  • Either download the archive of the release of your choice from https://github.com/olets/zsh-abbr/releases and expand it (ensures you have the latest official release)
  • or clone a single branch:
    shell
    git clone https://github.com/olets/zsh-abbr --recurse-submodules --single-branch --branch <branch> --depth 1
    Replace <branch> with a branch name. Good options are main (for the latest stable release), next (for the latest release, even if it isn't stable), or v6 (for releases in this major version).

Then add source path/to/zsh-abbr.zsh to your .zshrc (replace path/to/ with the real path), and restart zsh:

shell
exec zsh