A Tmux layout generator and command executor, similar to tmuxinator, tmux-xpanes or i2ssh.
tmuxer is a small Bash script to automatically create multiple Tmux panes, and optionally run a command in each pane. Features include:
- The command to run can be global (ie, the same command is run in all panes and each pane provides a different target argument), or individual commands can be run per-pane.
- Input is synchronized across all panes by default.
- The ability to choose Tmux layout.
- The ability to create a new session or create a new window if attached to an existing Tmux session.
sudo wget -O /usr/local/bin/tmuxer https://raw.githubusercontent.com/tjhop/tmuxer/main/tmuxer- Install
tmux(instructions will be specific to the distro you're running). - Clone this repo.
- Symlink
tmuxerscript somewhere in your$PATH.
tmuxer is now available in the AUR for Archlinux!
Basic AUR install:
git clone https://aur.archlinux.org/tmuxer-git.git aur/tmuxer-git
cd aur/tmuxer-git/
makepkg -si PKGBUILD
tmuxer accepts several flags that you can use to configure it's behavior:
$ tmuxer -h
Usage:
-h, --help Show help
-b, --blank [<integer>] How many blank tmux panes to create in the new window
-c, --command Set command to be executed in each pane (default: `echo {}`). The command should contain `{}` where you
intend to substitute the pane's target argument. Multiple substituions can be made per pane.
For example: `dig {} +short`
-d, --dump Write out a tmuxer config file to stdout based on the provided command line arguments
-f, --file [<file>] Config file to read from. The following paths are checked for the specified file:
Absolute path, relative path to current directory, and `$XDG_CONFIG_HOME/tmuxer`
-l, --layout [<layout>] Tmux layout to use
Valid options: `tiled`, `even-horizontal`, `even-vertical`, `main-horizontal`, `main-vertical`
Default: `tiled`
-n, --new-session Create new tmux session (default only if attached session not detected)
-p, --path Path to starting directory fo
8000
r new sessions/windows created by tmuxer (default: empty)
-s, --ssh "SSH Mode". Changes command to `ssh {}` (Same as: `--command 'ssh {}'`)
-u, --unsync Disable synchronization of panes (default: pane input is synchronized)
-w, --window-name What to name the tmux window created to hold panes
"Targets" for each Tmux pane can be provided as command line arguments, by piping/redirecting data to tmuxer, or by writing a config file. Checkout the examples below!
$ tmuxer --new-session --unsync --ssh user@host{01..10}
# same as:
$ tmuxer -n -u -s user@host{01..10}$ dig cloudfront.com +short | tmuxer --command 'dig -x {} +short' --layout 'even-vertical'
# same as:
$ dig cloudfront.com +short | tmuxer -c 'dig -x {} +short' -l 'even-vertical'$ tmuxer -c '{}' \
"for i in {1..3}; do echo \"test #\$i\"; done" \
"date" \
"ls -lh \$HOME/github/tmuxer" \
"cd \$HOME/github/tmuxer && git status"$ tmuxer -n -b 4
# same as:
$ tmuxer -n -c '{}' '' '' '' ''$ cat<<EOF > /tmp/tmuxer-example
TMUXER_LAYOUT='even-vertical'
TMUXER_DISABLE_SYNC=1
TMUXER_NEW_SESSION=1
TMUXER_COMMAND='echo "{}": && dig {} +short'
TMUXER_WORK_DIR=""
TMUXER_PANES=(
"google.com"
"cloudflare.com"
"packet.net"
"linode.com"
)
EOF
$ tmuxer -f /tmp/tmuxer-exampleUseful if you've created a tmuxer CLI command that you'd like to re-use in the future as a config file. Example:
$ tmuxer --new-session --ssh user@host{01..04}Using the -d/--dump flag, a tmuxer config file will be written to stdout (which can of course be redirected to a file of your choosing):
$ tmuxer --dump --new-session --ssh user@host{01..04}
TMUXER_LAYOUT="tiled"
TMUXER_DISABLE_SYNC=0
TMUXER_NEW_SESSION=1
TMUXER_COMMAND="ssh {}"
TMUXER_WORK_DIR=""
TMUXER_PANES=(
user@host01
user@host02
user@host03
user@host04
)Connecting to multiple hosts with ssh:
Using a config file with tmuxer:
Running arbitrary commands with data from stdin:
Tmuxer will attempt to load configuration files in the following order:
- By absolute path, if provided
- By relative path to the working directory where
tmuxeris invoked from - By relative path to
$XDG_CONFIG_HOME/tmuxeras a fallback
| Variable Name | Variable Type | Description | Accepted Values | Default Value |
|---|---|---|---|---|
TMUXER_COMMAND |
string | A command to be run in each Tmux pane opened. This will prefix any commands/arguments provided in that specific pane's command provided in the PANES array Be careful! Commands are entered directly into the terminal and run. This can be dangerous. Note: If providing shell variables, you will need to escape them. |
any | empty string |
TMUXER_PANES |
array of strings | A list of command targets to be run. Each command/argument specified will open a new Tmux pane for the command to be run in. Be careful! Commands are entered directly into the terminal and run. This can be dangerous. Note: If providing shell variables, you will need to escape them. |
any | empty array |
TMUXER_LAYOUT |
string | The Tmux layout to apply to the panes | even-vertical, even-horizontal, main-vertical, main-horizontal, tiled |
tiled |
TMUXER_DISABLE_SYNC |
integer | Whether or not to synchronize panes to broadcast input to all terminals | 1 (Disable sync)0(Enable sync) |
0 |
TMUXER_NEW_SESSION |
string | Whether or not to create a new Tmux session to hold the panes. This is the default if no attached session is detected. |
1 (Yes) 0 (No) |
0(unless no attached session detected) |
This project is licensed as MIT.