README.md

zsh-ssh

Better host completion for ssh in Zsh.

• zsh-ssh
  • Installation
    • Zinit
    • Antigen
    • Oh My Zsh
    • Sheldon
    • Manual (Git Clone)
  • Usage
    • SSH Config Example

Installation

Make sure you have fzf installed.

Zinit

zinit light sunlei/zsh-ssh

Antigen

antigen bundle sunlei/zsh-ssh

Oh My Zsh

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

   git clone https://github.com/sunlei/zsh-ssh ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-ssh

2. Add the plugin to the list of plugins for Oh My Zsh to load (inside ~/.zshrc):

   plugins=(zsh-ssh $plugins)

3. Start a new terminal session.

Sheldon

1. Add this config to ~/.config/sheldon/plugins.toml

   [plugins.zsh-ssh]
   github = 'sunlei/zsh-ssh'

2. Run sheldon lock to install the plugin.

3. Start a new terminal session.

Manual (Git Clone)

1. Clone this repository somewhere on your machine. For example: ~/.zsh/zsh-ssh.

   git clone https://github.com/sunlei/zsh-ssh ~/.zsh/zsh-ssh

2. Add the following to your .zshrc:

   source ~/.zsh/zsh-ssh/zsh-ssh.zsh

3. Start a new terminal session.

Usage

Just press Tab after ssh command as usual.

SSH Config Example

You can use #_Desc to set description.

~/.ssh/config

Host Bastion-Host
    Hostname 1.1.1.1
    User sunlei

Host Development-Host
    Hostname 2.2.2.2
    IdentityFile ~/.ssh/development-host
    #_Desc For Development