sshman

sshman is a command line tool for managing your ssh alias config easily, inspired by storm project, powered by Go.

Feature

• No dependence.
• Add, list, query, delete ssh alias record.
• Backup ssh config.
• Support Include directive.

Install

Gopher

go get -u github.com/sonnt85/sshman/cmd

Homebrew

brew tap sonnt85/tap
brew install sonnt85/tap/sshman

Manual

Download it from releases, and extract it to your PATH directory.

Usage

% sshman
NAME:
   sshman - Manage your ssh alias configs easily

USAGE:
   sshman [global options] command [command options] [arguments...]

VERSION:
   master

COMMANDS:
     add, a     Add a new SSH alias record
     list, l    List or query SSH alias records
     update, u  Update SSH record by specifying alias name
     delete, d  Delete SSH records by specifying alias names
     backup, b  Backup SSH config files
     get, g     Get opt of first alias  match
     completion generate the autocompletion script for the specified shell
     help, h    Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --file value, -f value  (default: "/Users/wendell/.ssh/config")
   --help, -h              show help
   --version, -v           print the version

Add a new alias

# sshman add test2 2.2.2.2
# sshman add test1 [email protected]:77 -c IdentityFile=~/.ssh/wendell
% sshman add test1 [email protected]:77 -i ~/.ssh/wendell
✔ alias[test1] added successfully.

        test1 -> [email protected]:77
                identityfile = /Users/wendell/.ssh/wendell

Username and port config is optional, the username is current login username and port is 22 by default.
Using -c to set more config options. For convenience, -i xxx can instead of -c identityfile=xxx.

List or query alias

# sshman list
# sshman list "*"
# sshman list Test -ic
% sshman list test1 77
✔ Listing 1 records.

        test1 -> [email protected]:77
                identityfile = /Users/wendell/.ssh/wendell

It will display all alias records If no params offered, or it will using params as keywords query alias records.
If there is a -it option, it will ignore case when searching.

Update an alias

# sshman update test1 -r test2
# sshman update test1 [email protected]:22022
% sshman update test1 -i "" -r test3 -c hostname=3.3.3.3 -c port=22022
✔ alias[test3] updated successfully.

        test3 -> [email protected]:22022

Update an existing alias record, it will replace origin user, hostname, port config's if connected string param offered.
You can use -c to update single and extra config option, -c identityfile= -c proxycommand= will remove identityfile and proxycommand options.
For convenience, -i xxx can instead of -c identityfile=xxx
Rename the alias specified by -r flag.

Delete one or more alias

# sshman delete test1
% sshman delete test1 test2
✔ alias[test1,test2] deleted successfully.

Backup ssh config

% sshman backup ./config_backup
✔ backup ssh config to [./config_backup] successfully.

For Include directive

If you use the Include directive, there are some extra notes.

Add -p(--path) flag for list,add,update,delete command to show the file path where the alias is located, it can also be set by the SSHMAN_SHOW_PATH environment variable.

Add -ap(--addpath) flag for add command to specify the file path to which the alias is added, it can also be set by the SSHMAN_ADD_PATH environment variable.

For convenience, you can export these environments in your .zshrc or .bashrc, example:

export SSHMAN_SHOW_PATH=true
export SSHMAN_ADD_PATH=~/.ssh/config.d/temp

Licence

MIT License