6 Commits
Author SHA1 Message Date
matmoul ba79cedcb1 docs: remove outdated group naming note 2026-06-02 20:37:27 +02:00
matmoul 87945adae3 feat: require explicit group names in host configs 2026-06-02 20:36:51 +02:00
matmoul 69131534fe feat: support jump host ports in SSH menu
Allow jump host definitions to include an explicit port in the form user@host:port.
Default to port 22 when no port is provided and update the sample config and docs accordingly.
2026-06-02 20:26:25 +02:00
matmoul c29d0dcb5d docs: record known follow-up improvements for jump server config 2026-06-01 01:04:58 +02:00
matmoul c942d95ec6 fix: reset aliases when loading each server 2026-06-01 00:53:06 +02:00
matmoul ba7df89340 fix: default known-hosts user to current user 2026-06-01 00:22:51 +02:00
7 changed files with 44 additions and 20 deletions
+3
View File
@@ -8,3 +8,6 @@
- Sample config is stored in `sample-config/` and mirrors current script behavior. - Sample config is stored in `sample-config/` and mirrors current script behavior.
- Documentation language: English. - Documentation language: English.
- Current task focus: keep README and memory aligned with the working script and sample configuration. - Current task focus: keep README and memory aligned with the working script and sample configuration.
- Sample host files currently use numbered names: `01_prod.yaml`, `02_staging.yaml`, `03_dev.yaml`.
- Known follow-up improvements:
- Each group should have default values.
+15 -4
View File
@@ -5,6 +5,8 @@ A Bash SSH target picker built around `fzf` and YAML configuration.
## What it does ## What it does
- Lists SSH targets from grouped YAML files - Lists SSH targets from grouped YAML files
- Uses the `group` value from each YAML file as the displayed group name
- Allows the YAML file name to differ from the group name
- Supports global defaults for user, port, and jump hosts - Supports global defaults for user, port, and jump hosts
- Supports per-host overrides - Supports per-host overrides
- Can also browse entries from `~/.ssh/known_hosts` - Can also browse entries from `~/.ssh/known_hosts`
@@ -45,12 +47,14 @@ ssh:
default_options: "" default_options: ""
jump_hosts: jump_hosts:
office: "user@192.168.10.11" office: "user@192.168.10.11"
office-alt: "user@192.168.10.11:2222"
``` ```
### `hosts/dev.yaml` ### `hosts/01_prod.yaml`
```yaml ```yaml
group: dev group: prod
servers: servers:
- name: api-1 - name: api-1
aliases: aliases:
@@ -69,10 +73,10 @@ servers:
port: 22 port: 22
``` ```
### `hosts/prod.yaml` ### `hosts/03_dev.yaml`
```yaml ```yaml
group: prod group: dev
servers: servers:
- name: web-1 - name: web-1
aliases: aliases:
@@ -82,6 +86,10 @@ servers:
jump_host: office jump_host: office
``` ```
The file name does not need to match the `group` value. The script reads the `group` from the YAML content and uses the file path internally to load the selected host.
The sample configuration now uses numbered file names such as `01_prod.yaml`, `02_staging.yaml`, and `03_dev.yaml`.
Each host entry can define: Each host entry can define:
- `name` - `name`
@@ -98,9 +106,12 @@ A complete sample configuration is available in `sample-config/`.
## Notes ## Notes
- `jump_host` values are resolved by name from `global.yaml`. - `jump_host` values are resolved by name from `global.yaml`.
- Jump hosts support `user@host` and `user@host:port`; if the port is omitted, `22` is used.
- 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. - `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. - The sample config includes `ssh_options` in one file, but the current script does not consume it yet.
- Sample host examples are stored as `sample-config/hosts/01_prod.yaml`, `02_staging.yaml`, and `03_dev.yaml`.
- The `group` key is required for each host config file; the file name is only an internal storage detail.
- When `-k` is used, entries from `known_hosts` are shown with the selected user or `root` by default. - When `-k` is used, entries from `known_hosts` are shown with the selected user or `root` by default.
- `known_hosts` entries use port `22`. - `known_hosts` entries use port `22`.
- The script uses strict Bash mode (`set -euo pipefail`). - The script uses strict Bash mode (`set -euo pipefail`).
+24 -16
View File
@@ -3,7 +3,7 @@ set -euo pipefail
CONFIG_DIR="$HOME/.config/mtm-ssh-menu" CONFIG_DIR="$HOME/.config/mtm-ssh-menu"
USE_KNOWN_HOSTS=0 USE_KNOWN_HOSTS=0
USE_KNOWN_HOSTS_USER="root" USE_KNOWN_HOSTS_USER=$(whoami)
usage() { usage() {
cat <<'EOF' cat <<'EOF'
@@ -34,7 +34,6 @@ parse_args() {
--known-hosts|-k) --known-hosts|-k)
USE_KNOWN_HOSTS=1 USE_KNOWN_HOSTS=1
if [ $# -eq 1 ]; then if [ $# -eq 1 ]; then
USE_KNOWN_HOSTS_USER="root"
shift shift
else else
USE_KNOWN_HOSTS_USER="$2" USE_KNOWN_HOSTS_USER="$2"
@@ -95,12 +94,13 @@ load_config() {
for file in "$HOSTS_DIR"/*.yaml; do for file in "$HOSTS_DIR"/*.yaml; do
local FILE_CONTENT GROUP_NAME GROUP_SERVERS INDEX local FILE_CONTENT GROUP_NAME GROUP_SERVERS INDEX
FILE_CONTENT="$(<"$file")" FILE_CONTENT="$(<"$file")"
GROUP_NAME=$(basename "$file") GROUP_NAME=$(yq -r '.group // empty' <<<"$FILE_CONTENT")
GROUP_NAME=${GROUP_NAME%.*} if [ "$GROUP_NAME" = "" ]; then
GROUP_NAME=$(yq -r '.group // "'"$GROUP_NAME"'"' <<<"$FILE_CONTENT") printf 'Error: missing group name in config file: %s\n' "$file" >&2
exit 1
fi
GROUP_SERVERS=$(yq -r '.servers // []' <<<"$FILE_CONTENT") GROUP_SERVERS=$(yq -r '.servers // []' <<<"$FILE_CONTENT")
INDEX=0 INDEX=0
for ((i=0; i<$(jq -r '. | length' <<<"$GROUP_SERVERS"); i++)); do for ((i=0; i<$(jq -r '. | length' <<<"$GROUP_SERVERS"); i++)); do
local SSH_SERVER_NAME SSH_SERVER_ALIASES ALIASES SSH_SERVER_HOST SSH_SERVER_PORT SSH_SERVER_USER local SSH_SERVER_NAME SSH_SERVER_ALIASES ALIASES SSH_SERVER_HOST SSH_SERVER_PORT SSH_SERVER_USER
SSH_SERVER_NAME=$(jq -r '.'"[$i]"'.name // ""' <<<"$GROUP_SERVERS") SSH_SERVER_NAME=$(jq -r '.'"[$i]"'.name // ""' <<<"$GROUP_SERVERS")
@@ -108,6 +108,7 @@ load_config() {
SSH_SERVER_HOST=$(jq -r '.'"[$i]"'.host // ""' <<<"$GROUP_SERVERS") SSH_SERVER_HOST=$(jq -r '.'"[$i]"'.host // ""' <<<"$GROUP_SERVERS")
SSH_SERVER_PORT=$(jq -r '.'"[$i]"'.port // "'"$DEFAULT_SSH_PORT"'"' <<<"$GROUP_SERVERS") SSH_SERVER_PORT=$(jq -r '.'"[$i]"'.port // "'"$DEFAULT_SSH_PORT"'"' <<<"$GROUP_SERVERS")
SSH_SERVER_USER=$(jq -r '.'"[$i]"'.user // "'"$DEFAULT_SSH_USER"'"' <<<"$GROUP_SERVERS") SSH_SERVER_USER=$(jq -r '.'"[$i]"'.user // "'"$DEFAULT_SSH_USER"'"' <<<"$GROUP_SERVERS")
ALIASES=""
if [ "$SSH_SERVER_ALIASES" != "" ]; then if [ "$SSH_SERVER_ALIASES" != "" ]; then
# shellcheck disable=SC2027 # shellcheck disable=SC2027
ALIASES="("$(echo "$SSH_SERVER_ALIASES" | jq -r 'join(", ")')")" ALIASES="("$(echo "$SSH_SERVER_ALIASES" | jq -r 'join(", ")')")"
@@ -115,10 +116,9 @@ load_config() {
if [ "$SERVERS" != "" ]; then if [ "$SERVERS" != "" ]; then
SERVERS+="\n" SERVERS+="\n"
fi fi
SERVERS+="${GROUP_NAME} | ${INDEX} | ${SSH_SERVER_HOST} | ${SSH_SERVER_NAME} ${ALIASES} | ${SSH_SERVER_USER} | ${SSH_SERVER_PORT}" SERVERS+="${GROUP_NAME} | ${file} | ${INDEX} | ${SSH_SERVER_HOST} | ${SSH_SERVER_NAME} ${ALIASES} | ${SSH_SERVER_USER} | ${SSH_SERVER_PORT}"
INDEX=$((INDEX+1)) INDEX=$((INDEX+1))
done done
done done
shopt -u nullglob shopt -u nullglob
} }
@@ -130,21 +130,22 @@ load_known_hosts() {
if [ "$SERVERS" != "" ]; then if [ "$SERVERS" != "" ]; then
SERVERS+="\n" SERVERS+="\n"
fi fi
SERVERS+="${GROUP_NAME} | ${host} | ${host} | ${host} | ${USE_KNOWN_HOSTS_USER} | 22" SERVERS+="${GROUP_NAME} | known_hosts | ${host} | ${host} | ${USE_KNOWN_HOSTS_USER} | 22"
done done
} }
popup_menu() { popup_menu() {
local SERVER local SERVER
SERVER=$(echo -e "${SERVERS}" | column -t -s "|" -o "|" | fzf -e --layout=reverse --with-nth=1,3,4,5,6 --delimiter="|") SERVER=$(echo -e "${SERVERS}" | column -t -s "|" -o "|" | fzf -e --layout=reverse --with-nth=1,4,5,6,7 --delimiter="|")
local GROUP_NAME HOST_INDEX local GROUP_NAME GROUP_SOURCE 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) GROUP_SOURCE=$(echo "$SERVER" | awk -F '|' '{print $2}' | xargs)
ssh_connect "$GROUP_NAME" "$HOST_INDEX" HOST_INDEX=$(echo "$SERVER" | awk -F '|' '{print $3}' | xargs)
ssh_connect "$GROUP_SOURCE" "$HOST_INDEX"
} }
ssh_connect() { ssh_connect() {
if [[ "$HOST_INDEX" != *"."* ]]; then if [[ "$HOST_INDEX" != *"."* ]]; then
local SERVER SSH_SERVER_USER SSH_SERVER_HOST SSH_SERVER_PORT SSH_SERVER_OPTIONS SSH_JUMP_HOST local SERVER SSH_SERVER_USER SSH_SERVER_HOST SSH_SERVER_PORT SSH_SERVER_OPTIONS SSH_JUMP_HOST
SERVER=$(cat "$HOSTS_DIR/$1.yaml" | yq -r '.servers'"[$2]") SERVER=$(yq -r '.servers['"$2"']' "$1")
SSH_SERVER_USER=$(jq -r '.user // "'"$DEFAULT_SSH_USER"'"' <<<"$SERVER") SSH_SERVER_USER=$(jq -r '.user // "'"$DEFAULT_SSH_USER"'"' <<<"$SERVER")
SSH_SERVER_HOST=$(jq -r '.host // ""' <<<"$SERVER") SSH_SERVER_HOST=$(jq -r '.host // ""' <<<"$SERVER")
SSH_SERVER_PORT=$(jq -r '.port // "'"$DEFAULT_SSH_PORT"'"' <<<"$SERVER") SSH_SERVER_PORT=$(jq -r '.port // "'"$DEFAULT_SSH_PORT"'"' <<<"$SERVER")
@@ -153,7 +154,14 @@ ssh_connect() {
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_USER=$(cut -d'@' -f1 <<<"$SSH_JUMP_HOST")
SSH_JUMP_HOST_TARGET=$(cut -d'@' -f2- <<<"$SSH_JUMP_HOST")
SSH_JUMP_HOST_TARGET_HOST=$(cut -d':' -f1 <<<"$SSH_JUMP_HOST_TARGET")
SSH_JUMP_HOST_TARGET_PORT=$(cut -s -d':' -f2 <<<"$SSH_JUMP_HOST_TARGET")
if [ "$SSH_JUMP_HOST_TARGET_PORT" = "" ]; then
SSH_JUMP_HOST_TARGET_PORT="22"
fi
SSH_JUMP_HOST="-t ${SSH_JUMP_HOST_USER}@${SSH_JUMP_HOST_TARGET_HOST} ssh -p ${SSH_JUMP_HOST_TARGET_PORT}"
SSH_SERVER_OPTIONS="" SSH_SERVER_OPTIONS=""
fi fi
@@ -165,10 +173,10 @@ ssh_connect() {
} }
main() { main() {
load_config
if [ "$USE_KNOWN_HOSTS" == 1 ]; then if [ "$USE_KNOWN_HOSTS" == 1 ]; then
load_known_hosts load_known_hosts
fi fi
load_config
popup_menu popup_menu
} }
+2
View File
@@ -4,3 +4,5 @@ ssh:
default_options: "" default_options: ""
jump_hosts: jump_hosts:
office: "user@192.168.10.11" office: "user@192.168.10.11"
dev: "user@192.168.10.11:2222"
backup: "admin@10.0.0.5:2200"