aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 7020efe4ee827fc0e5b345c0ed85c21b0bdfa66c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# tmux-toggle-term

A terminal toggle for tmux that supports a per-window split pane and a global floating popup.

## Installation

Using [TPM](https://github.com/tmux-plugins/tpm):

```tmux
set -g @plugin 'https://git.sr.ht/~eugenetriguba/tmux-toggle-term'
```

Reload tmux and press prefix + I to install.

## Usage

### Toggle Split Terminal

`C-;` → Toggle a split terminal for the current tmux window

![Split Pane](./docs/split-open.webp)

### Toggle Floating Terminal

`C-f` → Toggle a global floating popup terminal

![Floating Window](./docs/float-open.webp)

### Customization

If needed, you can override the default keybindings by setting the
`toggle-term-split-key` and `toggle-term-float-key` options.

```tmux
set -g @toggle-term-split-key 'M-t'
set -g @toggle-term-float-key 'M-f'
```