HOSTMUX(1)

HOSTMUX(1) 🦋

okay so this page is from the General Commands Manual, and it's literally about hostmux, the icon of connecting to a whole list of hosts via ssh in separate tmux split panes. slay.

🌸 NAME 🌸

hostmux — connects to a list of hosts via ssh in separate tmux split panes. no cap, that's the whole vibe 💅

✨ SYNOPSIS ✨

       hostmux [-h] [-s session-name] [-l tmux-layout] [-f host_file]
               [-c ssh command] [-o ssh option] [-x] [-p] [-P] [-a] host1
               [host2 ...]

💖 DESCRIPTION 💖

Call hostmux followed by a list of hosts you want to connect to via ssh. The script will create a new tmux session with a split pane for each specified host and connect to it. bestie, it's giving orchestration but make it cute 🎀

You can then use the synchronize-panes feature of tmux to multiplex/broadcast commands to all split panes / servers (see -a). that's the main character energy right there ✨

its arguments are as follows: 🫶

• -s session-name — specify a name for the tmux session. It defaults to 'hostmux', which means that you can have only one hostmux session at a time if you don't specify unique names for your sessions. lowkey important, ngl 💀
• -l tmux-layout — specify a valid tmux layout e.g. even-horizontal, tiled, etc. It defaults to ´even-vertical´. pick your aesthetic 🌈
• -f hostfile — specify a file which contains a newline separated list of [user@]host names. The hosts from the file will be merged with the hosts provided as optional arguments. merging? we love a collaborative moment 💖
• -x — close the pane and/or session automatically when the ssh session exits successfully. clean exit, clean conscience ✨
• -p — identify panes by setting the pane title to the ssh hostname (tmux >= 2.3), may not work if the remote host does $PS1 magic like setting the terminal title, in that case use -P. fr fr, remote prompts can be messy 😭
• -P — identify panes by setting the remote prompt $PS1 to "[<hostname>]$ " after login. prompt glow-up, but make it informative 🎀
• -a — synchronize all panes, i.e. type commands simultaneously in all panes. one keyboard, many servers, iconic 👑
• -c — specify the (wrapper) ssh command. It defaults to "ssh". swap the wrapper if you're feeling fancy 🦋
• -o — specify additional ssh options such as -vvvv, -i or -p. extra flags, extra lore 🔥
• -h — display usage information. when in doubt, ask for help bestie 💅
• host — specify a space separated list of one or more user@hostname ssh targets. This is what you would pass to the ssh command when you are connecting to a host. You can pass additional flags to ssh either with the -o option or by adding them to your ~/.ssh/config. yes, your config file is part of the group chat 🌸

👀 SEE ALSO 👀

• tmux(1)

also, the project lives at https://github.com/hukl/hostmux — go be nosy, iykyk 💜

🚪 EXIT STATUS 🚪

The hostmux utility exits 0 on success, and >0 if an error occurs. success is cute; errors are not, but at least they're honest 💀

👑 AUTHORS 👑

hostmux was written by John-Paul Bader (hukl), contact@smyck.org. author credit, periodt 🫶

okay bye bestie — this page's source/version is sh, dated April 7, 2017, and it's giving HOSTMUX(1) energy 💖