zsh-ssh

Enhanced SSH host management and completion for Zsh with fzf integration.

Features

• 🔍 Interactive host selection with fzf
• 📝 SSH config management (add/modify/remove)
• 🔐 Secure password storage with base64 encoding
• 🎯 Smart host completion with descriptions
• 📋 Detailed host information preview
• 🔄 Proxy command support
• 📦 Backup mechanism for config changes

Dependencies

Before installing zsh-ssh, make sure you have the following tools installed:

Required Dependencies

fzf (Fuzzy Finder)

# macOS
brew install fzf

# Ubuntu/Debian
sudo apt-get install fzf

# CentOS/RHEL
sudo yum install fzf

# Arch Linux
sudo pacman -S fzf

gawk (GNU awk)

# macOS
brew install gawk

# Ubuntu/Debian
sudo apt-get install gawk

# CentOS/RHEL
sudo yum install gawk

# Arch Linux
sudo pacman -S gawk

Optional Dependencies

sshpass (for password authentication)

# macOS
brew install sshpass

# Ubuntu/Debian
sudo apt-get install sshpass

# CentOS/RHEL
sudo yum install sshpass

# Arch Linux
sudo pacman -S sshpass

Installation

Make sure you have installed all the required dependencies before proceeding.

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

SSH Host Completion

Press Tab after ssh command to get interactive host selection with fzf.

SSH Config Management

Add New Host

sshadd

Interactive prompt to add a new SSH host configuration.

Modify Existing Host

sshmod [hostname]

• Without hostname: Interactive selection with fzf
• With hostname: Directly modify specified host

Remove Host

sshrm [hostname]

• Without hostname: Interactive selection with fzf
• With hostname: Directly remove specified host

SSH Config Example

You can use #_Desc to set description and #_Password for encrypted password storage.

~/.ssh/config

# Development Server
Host dev-server
    Hostname 1.1.1.1
    User developer
    #_Desc Development Environment
    #_Password <base64-encoded-password>
    IdentityFile ~/.ssh/dev-key

# Production Server
Host prod-server
    Hostname 2.2.2.2
    User admin
    #_Desc Production Environment
    Port 2222
    ProxyCommand ssh -q -W %h:%p [email protected]

Features in Detail

Interactive Host Selection

• Fuzzy search through all configured hosts
• Preview host details in real-time
• Color-coded descriptions
• Keyboard navigation support

Secure Password Management

• Passwords stored in base64 encoding
• Optional password authentication
• Secure password input (hidden)

Proxy Support

• Jump server configuration
• Custom proxy commands
• Proxy user specification

Backup System

• Automatic backup before modifications
• Timestamped backup files
• Config validation

Requirements

• zsh
• fzf (required)
• gawk (required)
• base64 (usually pre-installed)
• sshpass (optional, for password authentication)