https://github.com/lrwx00t/sshmate
Simple SSH Manager
https://github.com/lrwx00t/sshmate
linux macos ssh ssh-connection ssh-manager ssh-manager-cli terminal tool
Last synced: 14 days ago
JSON representation
Simple SSH Manager
- Host: GitHub
- URL: https://github.com/lrwx00t/sshmate
- Owner: lrwx00t
- Created: 2023-03-05T20:10:15.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-26T05:00:46.000Z (about 3 years ago)
- Last Synced: 2025-10-12T13:32:11.098Z (7 months ago)
- Topics: linux, macos, ssh, ssh-connection, ssh-manager, ssh-manager-cli, terminal, tool
- Language: Shell
- Homepage:
- Size: 16.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sshmate
`sshmate` is a tool designed to simplify interactions with SSH servers. It provides an easy way to connect to servers by assigning a name to an address. After adding a connection, you can directly connect to the server using the name you provided. It also allows adding log messages to existing connections. These log messages serve as additional descriptions of the server, making it easier to remember what the server is for and how it's been changed over time. For example, you might add log messages like *upgraded mysql* or *installed nginx using latest version*. Then, when you need to connect to the server again, you can simply search for keywords in the log messages to quickly find the server you need.
`sshmate` also supports symbolic links, which means that `sshmate` can be installed at any path. `sshmate` includes an autocompletion feature that makes it easy to quickly navigate between connction names using the `tab` key.
## Installation
You need to clone the repo and `cd` in the root folder `sshmate` before proceeding further. This can be done by running the following:
```bash
git clone https://github.com/lrwx00t/sshmate
cd sshmate
```
### Using `Makefile`
```bash
make install
```
### Manual Installation
* Create a symlink to `sshmate` script
```bash
ln -s {REPO_PATH}/sshmate /usr/local/bin/sshmate
```
* Install the auto-completion script e.g. `in your ~/.zshrc`:
```bash
source {REPO_PATH}/sshmate-completion.bash
```
## Usage
```bash
❯ sshmate -h
Usage: sshmate -c (connect to an existing connection)
sshmate -l (list all connections)
sshmate -n -a
(add a new connection)
sshmate -a -d (add a log message to an existing
connection)
sshmate -s (connection to an existing connection
by a matching text in the log)
sshmate -r (remove connection)
Options:
-c (connect to an existing connection name)
-l (list all connections)
-n (add a new connection name)
-a (add a connection address, used with -n)
-d (add a log message to an existing connection)
-r (remove an existing connection)
-s (connect to a machine using an existing
connection by finding match in the logs)
-h (show this message for usage help)
Example: Connect to an existing connection name
sshmate -c do_linux_centos7
Create a new connection
sshmate -n do_linux_centos7 -a root@10.10.10.1
Create a new connection
sshmate -a do_linux_centos7 -d "installed mysql latest version"
Connect to an existing connection by searching for a match in the logs
sshmate -s mysql
```
## Examples
### Add a new connection
```bash
❯ sshmate -n do_linux_ubuntu16 -a nonroot@10.10.10.2
adding new connection..
Adding [nonroot@10.10.10.2] connection with the name: do_linux_ubuntu16%
```
### List all connections
```bash
❯ sshmate -l
listing all SSH connections...
do_linux_centos7 ==> root@10.10.10.1
do_linux_ubuntu16 ==> nonroot@10.10.10.2
do_linux_rh ==> root@10.10.10.3
```
### Connect to one of the listed/existing connections
```bash
❯ sshmate -c do_linux_centos7
checking connection:do_linux_centos7
connecting to: root@10.10.10.1
ssh root@10.10.10.1
```
### Add/append a log message to an existing connection
```bash
❯ sshmate -a do_linux_centos7 -d "installed mysql with new test db"
adding new connection..
add a description to existing connection
description is: installed mysql with new test db
got connection: do_linux_centos7
```
### Use a log message lookup to access an existing connection
```bash
❯ sshmate -s mysql
connecting to: root@10.10.10.1
```