4 Commits
Author SHA1 Message Date
matmoul ba7df89340 fix: default known-hosts user to current user 2026-06-01 00:22:51 +02:00
matmoul 8650b71c3c docs: align README with current script behavior
Update the usage, feature summary, and notes to reflect known_hosts support, current option flags, and the sample configuration layout.
2026-06-01 00:03:59 +02:00
matmoul 59f37d8455 feat: add known_hosts entries to ssh menu
Allow loading hosts from ~/.ssh/known_hosts via -k, with an optional user override. Also update the usage text and keep direct SSH connections working for generated known_hosts entries.
2026-05-31 23:59:29 +02:00
matmoul ccd38c5e31 fix: use fzf reverse layout in SSH menu 2026-05-31 22:57:40 +02:00
3 changed files with 88 additions and 40 deletions
+2 -2
View File
@@ -5,6 +5,6 @@
- Main entry point: `mtm-ssh-menu` - Main entry point: `mtm-ssh-menu`
- Configuration: `~/.config/mtm-ssh-menu/global.yaml` and `hosts/*.yaml` by default. - Configuration: `~/.config/mtm-ssh-menu/global.yaml` and `hosts/*.yaml` by default.
- Dependencies: `bash`, `ssh`, `fzf`, `jq`, `yq`. - Dependencies: `bash`, `ssh`, `fzf`, `jq`, `yq`.
- Sample config is stored in `sample-config/`. - Sample config is stored in `sample-config/` and mirrors current script behavior.
- Documentation language: English. - Documentation language: English.
- Current task focus: keep README aligned with the working script and sample configuration. - Current task focus: keep README and memory aligned with the working script and sample configuration.
+38 -19
View File
@@ -1,18 +1,17 @@
# mtm-ssh-menu # mtm-ssh-menu
A small Bash utility to browse SSH targets from YAML configuration and connect to them with `fzf`. A Bash SSH target picker built around `fzf` and YAML configuration.
## Features ## What it does
- Interactive selection with `fzf` - Lists SSH targets from grouped YAML files
- Global defaults for SSH user, port, and jump hosts - Supports global defaults for user, port, and jump hosts
- Per-host overrides in grouped YAML files - Supports per-host overrides
- Support for jump hosts via named aliases - Can also browse entries from `~/.ssh/known_hosts`
- Simple, dependency-light Bash script - Launches `ssh` directly from the selected entry
## Requirements ## Requirements
- `bash`
- `ssh` - `ssh`
- `fzf` - `fzf`
- `jq` - `jq`
@@ -21,13 +20,14 @@ A small Bash utility to browse SSH targets from YAML configuration and connect t
## Usage ## Usage
```bash ```bash
./mtm-ssh-menu [--config-dir DIR] ./mtm-ssh-menu [--config-dir DIR] [-k [user]]
``` ```
Options: Options:
- `--help`: show help - `-h`, `--help`: show help
- `--config-dir DIR`: use a custom configuration directory - `--config-dir DIR`: use a custom configuration directory
- `-k`, `--known-hosts [user]`: include hosts from `~/.ssh/known_hosts`
By default, the script reads configuration from: By default, the script reads configuration from:
@@ -59,6 +59,27 @@ servers:
host: 192.168.10.11 host: 192.168.10.11
user: dev user: dev
port: 2222 port: 2222
- name: web-1
aliases:
- frontend
- ui
host: 192.168.10.12
user: dev
port: 22
```
### `hosts/prod.yaml`
```yaml
group: prod
servers:
- name: web-1
aliases:
- frontend
- web
host: web-1.prod.internal
jump_host: office
``` ```
Each host entry can define: Each host entry can define:
@@ -70,19 +91,17 @@ Each host entry can define:
- `port` - `port`
- `jump_host` - `jump_host`
## Example workflow
1. Create the config directory.
2. Add `global.yaml` and one or more files under `hosts/`.
3. Run the script.
4. Select a target in the menu and connect.
## Sample configuration ## Sample configuration
A complete sample configuration is available in `sample-config/`. A complete sample configuration is available in `sample-config/`.
## Notes ## Notes
- The script requires `yq`, `jq`, `ssh`, and `fzf` to be installed. - `jump_host` values are resolved by name from `global.yaml`.
- Jump hosts are resolved by name from `global.yaml`.
- If a host does not define a user or port, global defaults are used. - If a host does not define a user or port, global defaults are used.
- `default_options` is present in the config but not consumed by the current script.
- The sample config includes `ssh_options` in one file, but the current script does not consume it yet.
- When `-k` is used, entries from `known_hosts` are shown with the selected user or `root` by default.
- `known_hosts` entries use port `22`.
- The script uses strict Bash mode (`set -euo pipefail`).
- The script name shown in usage is `sshm`, while the repository file is `mtm-ssh-menu`.
+48 -19
View File
@@ -2,14 +2,17 @@
set -euo pipefail set -euo pipefail
CONFIG_DIR="$HOME/.config/mtm-ssh-menu" CONFIG_DIR="$HOME/.config/mtm-ssh-menu"
USE_KNOWN_HOSTS=0
USE_KNOWN_HOSTS_USER=$(whoami)
usage() { usage() {
cat <<'EOF' cat <<'EOF'
Usage: sshm [--config-dir DIR] Usage: sshm [--config-dir DIR] [-k [user]]
Options: Options:
--help Show this help message -h | --help Show this help message
--config-dir DIR Use a custom config directory --config-dir DIR Use a custom config directory
-k | --known-hosts [user] Include known_hosts
The config directory must contain: The config directory must contain:
- global.yaml - global.yaml
@@ -28,6 +31,15 @@ parse_args() {
CONFIG_DIR="$2" CONFIG_DIR="$2"
shift 2 shift 2
;; ;;
--known-hosts|-k)
USE_KNOWN_HOSTS=1
if [ $# -eq 1 ]; then
shift
else
USE_KNOWN_HOSTS_USER="$2"
shift 2
fi
;;
--help|-h) --help|-h)
usage usage
exit 0 exit 0
@@ -109,35 +121,52 @@ load_config() {
done done
shopt -u nullglob shopt -u nullglob
} }
load_known_hosts() {
local FILE_CONTENT GROUP_NAME
FILE_CONTENT=$(cat "$HOME"/.ssh/known_hosts | awk -F ' ' '{print $1}' | sort | awk '!seen[$1]++')
GROUP_NAME="Local"
for host in $FILE_CONTENT; do
if [ "$SERVERS" != "" ]; then
SERVERS+="\n"
fi
SERVERS+="${GROUP_NAME} | ${host} | ${host} | ${host} | ${USE_KNOWN_HOSTS_USER} | 22"
done
}
popup_menu() { popup_menu() {
local SERVER local SERVER
SERVER=$(echo -e "${SERVERS}" | column -t -s "|" -o "|" | fzf -e --tac --with-nth=1,3,4,5,6 --delimiter="|") SERVER=$(echo -e "${SERVERS}" | column -t -s "|" -o "|" | fzf -e --layout=reverse --with-nth=1,3,4,5,6 --delimiter="|")
local GROUP_NAME HOST_INDEX local GROUP_NAME HOST_INDEX
GROUP_NAME=$(echo "$SERVER" | awk -F '|' '{print $1}' | xargs) GROUP_NAME=$(echo "$SERVER" | awk -F '|' '{print $1}' | xargs)
HOST_INDEX=$(echo "$SERVER" | awk -F '|' '{print $2}' | xargs) HOST_INDEX=$(echo "$SERVER" | awk -F '|' '{print $2}' | xargs)
ssh_connect "$GROUP_NAME" "$HOST_INDEX" ssh_connect "$GROUP_NAME" "$HOST_INDEX"
} }
ssh_connect() { ssh_connect() {
local SERVER SSH_SERVER_USER SSH_SERVER_HOST SSH_SERVER_PORT SSH_SERVER_OPTIONS SSH_JUMP_HOST if [[ "$HOST_INDEX" != *"."* ]]; then
SERVER=$(cat "$HOSTS_DIR/$1.yaml" | yq -r '.servers'"[$2]") local SERVER SSH_SERVER_USER SSH_SERVER_HOST SSH_SERVER_PORT SSH_SERVER_OPTIONS SSH_JUMP_HOST
SSH_SERVER_USER=$(jq -r '.user // "'"$DEFAULT_SSH_USER"'"' <<<"$SERVER") SERVER=$(cat "$HOSTS_DIR/$1.yaml" | yq -r '.servers'"[$2]")
SSH_SERVER_HOST=$(jq -r '.host // ""' <<<"$SERVER") SSH_SERVER_USER=$(jq -r '.user // "'"$DEFAULT_SSH_USER"'"' <<<"$SERVER")
SSH_SERVER_PORT=$(jq -r '.port // "'"$DEFAULT_SSH_PORT"'"' <<<"$SERVER") SSH_SERVER_HOST=$(jq -r '.host // ""' <<<"$SERVER")
SSH_SERVER_PORT=$(jq -r '.port // "'"$DEFAULT_SSH_PORT"'"' <<<"$SERVER")
SSH_SERVER_OPTIONS="-p $SSH_SERVER_PORT" SSH_SERVER_OPTIONS="-p $SSH_SERVER_PORT"
SSH_JUMP_HOST=$(jq -r '.jump_host // ""' <<<"$SERVER") SSH_JUMP_HOST=$(jq -r '.jump_host // ""' <<<"$SERVER")
if [ "$SSH_JUMP_HOST" != "" ]; then if [ "$SSH_JUMP_HOST" != "" ]; then
SSH_JUMP_HOST=$(jq -r '.'"$SSH_JUMP_HOST"' // ""' <<<"${SSH_JUMP_HOSTS}") SSH_JUMP_HOST=$(jq -r '.'"$SSH_JUMP_HOST"' // ""' <<<"${SSH_JUMP_HOSTS}")
SSH_JUMP_HOST="-t $SSH_JUMP_HOST ssh -p $SSH_SERVER_PORT" SSH_JUMP_HOST="-t $SSH_JUMP_HOST ssh -p $SSH_SERVER_PORT"
SSH_SERVER_OPTIONS="" SSH_SERVER_OPTIONS=""
fi
# shellcheck disable=SC2086
ssh ${SSH_SERVER_OPTIONS} ${SSH_JUMP_HOST} "${SSH_SERVER_USER}"@"${SSH_SERVER_HOST}"
else
ssh "${USE_KNOWN_HOSTS_USER}"@"${2}"
fi fi
#echo "ssh ${SSH_SERVER_OPTIONS} ${SSH_JUMP_HOST} ${SSH_SERVER_USER}@${SSH_SERVER_HOST}"
# shellcheck disable=SC2086
ssh ${SSH_SERVER_OPTIONS} ${SSH_JUMP_HOST} "${SSH_SERVER_USER}"@"${SSH_SERVER_HOST}"
} }
main() { main() {
if [ "$USE_KNOWN_HOSTS" == 1 ]; then
load_known_hosts
fi
load_config load_config
popup_menu popup_menu
} }