tsm/README.md

42 lines
1 KiB
Markdown
Raw Normal View History

2023-09-05 13:36:33 -05:00
# Tmux session manager (tsm)
## Install
There are pre-built binaries available in [Releases](https://github.com/daylinmorgan/tsm/releases/) including a [nightly](https://github.com/daylinmorgan/tsm/releases/tag/nightly) release.
w/`eget`:
```sh
eget daylinmorgan/tsm
eget daylinmorgan/tsm --pre-release # for nightly build
```
w/`nimble`:
```sh
nimble install https://github.com/daylinmorgan/tsm
```
## Usage
2023-11-10 13:51:00 -06:00
To configure `tsm` export the below environment variables:
2024-09-14 10:15:14 -05:00
> `TSM_PATHS`: a colon-delimited set of parent directories to find projects. \
2023-11-10 13:51:00 -06:00
> `TSM_HEIGHT`: integer specifying number of rows in terminal (default: 15)
2023-09-05 13:36:33 -05:00
For example in your rc file:
```sh
2024-09-14 10:15:14 -05:00
export TSM_PATHS="$HOME/projects/personal:$HOME/projects/work"
2023-09-05 13:36:33 -05:00
```
To make full use of `tsm` you should also add a new key binding to your `tmux.conf`.
2023-11-10 13:51:00 -06:00
For example, you can bind the f key to show a popup with `tsm`:
2023-09-05 13:36:33 -05:00
```sh
2023-10-02 12:18:43 -05:00
bind f display-popup \
2023-09-05 13:36:33 -05:00
-h 60% -w 60% \
-E "tsm"
```
## Prior Art
- [ThePrimeagen](https://github.com/ThePrimeagen/.dotfiles/blob/master/bin/.local/scripts/tmux-sessionizer)