https://github.com/doronbehar/tmux-sessions-attacher
https://github.com/doronbehar/tmux-sessions-attacher
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/doronbehar/tmux-sessions-attacher
- Owner: doronbehar
- Created: 2018-03-08T17:57:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-23T23:20:15.000Z (about 7 years ago)
- Last Synced: 2025-02-07T04:45:59.874Z (4 months ago)
- Language: Shell
- Size: 6.84 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tmux Sessions Attacher
This project strives to address a task many tmux users execute regularly and it is attaching to existing tmux sessions on remote / local machines - like Virtual Private Servers and other animals.
## Installation
- For Arch Linux Users: Install the AUR package: [`tmux-sessions-attacher`](https://aur.archlinux.org/packages/tmux-sessions-attacher).
- For everyone else: Just put the script in your `$PATH`, you know the drill. It's recommended to add the desktop entry file included in this repository ([`tmux-sessions-attacher.desktop`](tmux-sessions-attacher.desktop)) to your applications directory as well. Usually it means putting it in `~/.local/share/applications/` and running `update-desktop-database ~/.local/share/applications` is enough.
## Usage
Basically, the script is pretty simple, it reads a configuration file and searches on your servers for running tmux sessions and it prompts you for attaching them to a running terminal emulator. It uses (by default) non login shells inside the terminal emulator which gives a much smoother experience of attaching and detaching.
### Configuration
The configuration files are located (usually) at `~/.config/tmux-sessions-attacher/`. Each configuration defines a `{HOST}` with simple `variable = value` syntax. For example, the host myvps would be configured in `~/.config/tmux-sessions-attacher/myvps` just like that:
```sh
TERMINAL_EMULATOR="urxvt -e"
SSH_OPTIONS="-4"
TMUX_OPTIONS=""
```
The variables in the examples are the only one which will be checked by the script.
Default values for the above options can be defined in environmental variables. Create empty files to specify hosts which use the default configuration.
### Running
Basically you can run it either from a command prompt and the script will fork itself or you can put it in a `.desktop` file and run it from your desktop environment. Here is an example [`tmux-sessions-attacher.desktop`](tmux-sessions-attacher.desktop):
```desktop
[Desktop Entry]
Type=Application
Name=SSH Remote Tmux Session Manager
Exec=tmux-sessions-attacher
Keywords=shell;prompt;commandline;
Comment=Interactivly choose a Tmux session to attach on configured remote machines
Icon=utilities-terminal
Terminal=false
Categories=Utility;
MimeType=
```