zsh-autosuggestions/INSTALL.md
Ondrej Fabry b24b607fbf
Update INSTALL.md
- minor formatting change for better readability
2019-06-19 23:30:36 +02:00

2.0 KiB

Installation

Manual (Git Clone)

  1. Clone this repository somewhere on your machine. This guide will assume ~/.zsh/zsh-autosuggestions.

    git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions
    
  2. Add the following to your .zshrc:

    source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh
    
  3. Start a new terminal session.

Antigen

  1. Add the following to your .zshrc:

    antigen bundle zsh-users/zsh-autosuggestions
    
  2. Start a new terminal session.

Oh My Zsh

  1. Clone this repository into $ZSH_CUSTOM/plugins (by default ~/.oh-my-zsh/custom/plugins)

    git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
    
  2. Add the plugin to the list of plugins for Oh My Zsh to load (inside ~/.zshrc):

    plugins=(zsh-autosuggestions)
    
  3. Start a new terminal session.

Arch Linux

  1. Install zsh-autosuggestions from the community repository.

    pacman -S zsh-autosuggestions
    

    or, to use a package based on the master branch, install zsh-autosuggestions-git from the AUR.

  2. Add the following to your .zshrc:

    source /usr/share/zsh/plugins/zsh-autosuggestions/zsh-autosuggestions.zsh
    
  3. Start a new terminal session.

macOS via Homebrew

  1. Install the zsh-autosuggestions package using Homebrew.

    brew install zsh-autosuggestions
    
  2. Add the following to your .zshrc:

    source /usr/local/share/zsh-autosuggestions/zsh-autosuggestions.zsh
    
  3. Start a new terminal session.