9 releases

0.1.5 Apr 24, 2023
0.1.4 Jan 17, 2023
0.1.3 Oct 7, 2022
0.1.2 Jul 19, 2022
0.0.3 Mar 29, 2022

#613 in Command line utilities

45 downloads per month

MIT license

12KB
141 lines

sshq

This command line utility allows querying your ssh config.

Install

cargo install sshq

Usage

Main

`sshq` parses your ssh config and present the information back to you

Usage: sshq [OPTIONS] <COMMAND>

Commands:
  list    The `list` command returns the list of entries
  search  The `search` command searches for a given pattern
  help    Print this message or the help of the given subcommand(s)

Options:
  -j, --json     Output as json
  -h, --help     Print help information
  -V, --version  Print version information

List

The `list` command returns the list of entries

Usage: sshq list [OPTIONS]

Options:
  -j, --json     Output as json
  -h, --help     Print help information
  -V, --version  Print version information
The `search` command searches for a given pattern

Usage: sshq search [OPTIONS] [PATTERN]

Arguments:
  [PATTERN]  Search pattern

Options:
  -j, --json     Output as json
  -h, --help     Print help information
  -V, --version  Print version information

Use cases

You may find the following shell function convenient as it presents the list of available hosts and allow fuzzy search to connect to one. With this function defined (in your .bashrc for instance), you may invoke co if you have no idea and then use fuyy search to find the right server, pass a fuzzy pattern such as co srv123 (it will even allow typos…​), and it will connect directly if there is a single hit to your pattern.

function co() {
    SEARCH=${@:-''};
     if [ $SEARCH ]; then
        hit=$(sshq list | fzf -i -1 --query "$SEARCH" --preview 'sshq search {}')
    else
        hit=$(sshq list | fzf -i -1 --preview 'sshq search {}')
    fi
    echo "Connecting to $hit... you may need to insert your Yubikey..."
    ssh $hit
}

Dependencies

~9–18MB
~211K SLoC