2023-04-06 13:34:32 -04:00
|
|
|
|
|
|
|
|
# ReMux: a friendlier tmux wrapper
|
|
|
|
|
|
2023-06-15 00:21:23 -04:00
|
|
|
Pronounced \[ ɹ̠i məks \], like "remix."
|
|
|
|
|
|
2023-06-12 19:24:57 -04:00
|
|
|
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.
|
2023-04-06 13:34:32 -04:00
|
|
|
|
2023-06-12 19:24:57 -04:00
|
|
|
In their shortest forms, *every* ReMux command is as short or
|
|
|
|
|
shorter than its equivalent tmux command:
|
|
|
|
|
|
|
|
|
|
```sh
|
2023-04-06 13:34:32 -04:00
|
|
|
|
|
|
|
|
# new session
|
|
|
|
|
tmux new-session -t foo
|
|
|
|
|
remux n foo
|
|
|
|
|
|
|
|
|
|
# lists
|
|
|
|
|
tmux ls
|
|
|
|
|
remux l
|
2023-06-12 19:24:57 -04:00
|
|
|
remux
|
2023-04-06 13:34:32 -04:00
|
|
|
|
|
|
|
|
# attach
|
|
|
|
|
tmux a -t foo
|
|
|
|
|
remux a foo
|
|
|
|
|
|
2023-06-12 19:24:57 -04:00
|
|
|
# has
|
|
|
|
|
tmux has -t foo
|
|
|
|
|
remux has foo
|
|
|
|
|
|
|
|
|
|
# detach
|
|
|
|
|
tmux detach-client -t foo
|
|
|
|
|
remux d foo
|
|
|
|
|
|
2024-02-13 17:16:22 -05:00
|
|
|
# nesting sessions with '-n' flag
|
|
|
|
|
TMUX='' tmux a -t foo
|
|
|
|
|
remux a -n foo
|
|
|
|
|
TMUX='' tmux new-session -t foo
|
|
|
|
|
remux n -n foo
|
|
|
|
|
|
2023-04-06 13:34:32 -04:00
|
|
|
```
|
|
|
|
|
|
2024-02-19 19:39:35 -05:00
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
ReMux depends on [tmux](https://github.com/tmux/tmux).
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
### From Binary
|
|
|
|
|
|
|
|
|
|
Copy the compiled binary from the [releases page](https://git.vwolfe.io/valerie/remux/releases)
|
|
|
|
|
to a directory in `$PATH`, such as `/usr/bin/`.
|
|
|
|
|
|
|
|
|
|
### 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/`.
|
|
|
|
|
|
|
|
|
|
### Arch Linux (AUR)
|
|
|
|
|
|
|
|
|
|
Install the package from the [`remux` AUR Package](https://aur.archlinux.org/packages/remux),
|
|
|
|
|
either using an AUR package manager, or by cloning the [AUR Repository](https://aur.archlinux.org/remux.git)
|
|
|
|
|
and running the command `makepkg --install`.
|
|
|
|
|
|
2023-06-20 12:33:38 -04:00
|
|
|
## Libraries
|
|
|
|
|
|
|
|
|
|
- [pico-args](https://crates.io/crates/pico_args) — argument parsing
|
|
|
|
|
- [termion](https://crates.io/crates/termion) — ANSI formatting
|
2024-02-13 19:36:38 -05:00
|
|
|
- [tmux_interface](https://crates.io/crates/tmux_interface) — tmux communication
|
2023-06-13 10:29:28 -04:00
|
|
|
|
