A friendly tmux wrapper.
Find a file
2024-03-14 16:31:06 -04:00
src added help text for REMUX_NEW_WINDOW env var 2024-03-14 16:31:06 -04:00
.gitignore initial commit 2023-04-06 13:34:32 -04:00
Cargo.toml upgraded tmux_interface to 0.3.2 and restructured command module 2024-03-06 15:54:41 -05:00
LICENSE removed dead code and updated package information 2024-02-12 14:06:54 -05:00
README.md list attach symbol is now configurable 2024-03-06 16:12:54 -05:00

ReMux: a friendlier tmux wrapper

Pronounced [ ɹ̠i məks ], like "remix."

A tmux wrapper and command shortener written in Rust. ReMux's goal is to wrap tmux commands to be both shorter, and oriented around session names instead of session IDs.

To further simplify developer usage, the attach, detach, has, and new commands can be used without a target field, and will default to the name of the Git repository root directory, if one is found.

In their shortest forms, every ReMux command is as short or shorter than its equivalent tmux command:


#	new session
tmux new-session -t foo
remux n foo

#	lists
tmux ls
remux l
remux

#	attach
tmux a -t foo
remux a foo

#	has
tmux has -t foo
remux has foo

#	detach
tmux detach-client -t foo
remux d foo

#	nesting sessions with '-n' flag
TMUX='' tmux a -t foo
remux a -n foo
TMUX='' tmux new-session -t foo
remux n -n foo

Dependencies

ReMux depends on tmux.

Installation

Manual Install

Release Binary Copy the compiled binary from the releases page to a directory in $PATH, such as /usr/bin/.
Compile from Source Compile using cargo with the command cargo build --release and copy the file from target/release/ to a directory in $PATH, such as /usr/bin/.
makepkg (AUR) Clone the AUR Repository and run the command makepkg --install.

Package Managers

Arch Linux (AUR): remux Install the package from the remux AUR Package using an AUR package manager such as paru.
Cargo: tmux-remux Install the package using Cargo with the command cargo install tmux-remux.

Configuration

The pretty-print attached symbol (default: *) can be set manually by setting REMUX_ATTACH_SYMBOL.

Libraries