tmux-tui 1.3.2 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -1
- package/dist/tmuxtui.js +136 -136
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,6 +15,17 @@ Interactive terminal UI for managing tmux sessions. Browse, create, rename, deta
|
|
|
15
15
|
- **Works everywhere** — runs inside or outside tmux (auto-detects and uses `switch-client` or `attach-session`)
|
|
16
16
|
- **`init` command** — register the current directory as a new tmux session in one step
|
|
17
17
|
|
|
18
|
+
## Session persistence
|
|
19
|
+
|
|
20
|
+
tmux sessions live in the `tmux server` process memory. **Rebooting your machine kills the server and wipes every session** — this is a tmux behavior, not something tmuxtui can fix on its own (tmuxtui only persists your favorites list at `~/.config/tmuxtui/favorites.json`).
|
|
21
|
+
|
|
22
|
+
If you want sessions, windows, panes, and even some running programs to survive reboots, install the community-standard pair:
|
|
23
|
+
|
|
24
|
+
- [tmux-resurrect](https://github.com/tmux-plugins/tmux-resurrect) — manual save/restore of the full session tree
|
|
25
|
+
- [tmux-continuum](https://github.com/tmux-plugins/tmux-continuum) — automatic periodic save and auto-restore on tmux start
|
|
26
|
+
|
|
27
|
+
tmuxtui works seamlessly alongside both — they snapshot tmux's state to disk; tmuxtui reads whatever state the server currently has.
|
|
28
|
+
|
|
18
29
|
## Requirements
|
|
19
30
|
|
|
20
31
|
- Node.js >= 18
|
|
@@ -34,7 +45,7 @@ npm install -g tmux-tui
|
|
|
34
45
|
tmuxtui
|
|
35
46
|
```
|
|
36
47
|
|
|
37
|
-
Keyboard shortcuts:
|
|
48
|
+
Keyboard shortcuts (all customizable via config file):
|
|
38
49
|
|
|
39
50
|
| Key | Action |
|
|
40
51
|
|-----|--------|
|
|
@@ -45,10 +56,57 @@ Keyboard shortcuts:
|
|
|
45
56
|
| `x` | Detach session |
|
|
46
57
|
| `d` | Kill session (with confirm) |
|
|
47
58
|
| `c` | Config — window management |
|
|
59
|
+
| `i` | Session details (windows & panes) |
|
|
60
|
+
| `/` | Search sessions |
|
|
61
|
+
| `s` | Toggle favorite |
|
|
62
|
+
| `f` | Filter favorites only |
|
|
63
|
+
| `R` | Refresh session list |
|
|
64
|
+
| `Tab` | Mark / unmark session |
|
|
65
|
+
| `X` | Batch detach marked sessions |
|
|
66
|
+
| `D` | Batch kill marked sessions |
|
|
67
|
+
| `h` | Help |
|
|
48
68
|
| `q` | Quit |
|
|
49
69
|
|
|
50
70
|
When creating a new session, press `Tab` to switch between the name and path fields.
|
|
51
71
|
|
|
72
|
+
### Configuration
|
|
73
|
+
|
|
74
|
+
Create `~/.config/tmuxtui/config.json` to customize behavior:
|
|
75
|
+
|
|
76
|
+
```json
|
|
77
|
+
{
|
|
78
|
+
"defaultSort": "lastAttached",
|
|
79
|
+
"confirmBeforeKill": true,
|
|
80
|
+
"autoAttachOnCreate": false,
|
|
81
|
+
"refreshInterval": 0,
|
|
82
|
+
"keybindings": {
|
|
83
|
+
"quit": "escape",
|
|
84
|
+
"new": "n",
|
|
85
|
+
"kill": "d"
|
|
86
|
+
},
|
|
87
|
+
"ui": {
|
|
88
|
+
"showPath": true,
|
|
89
|
+
"showSessionId": false,
|
|
90
|
+
"sessionNameWidth": 20
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
#### Config options
|
|
96
|
+
|
|
97
|
+
| Option | Default | Description |
|
|
98
|
+
|--------|---------|-------------|
|
|
99
|
+
| `defaultSort` | `"lastAttached"` | Sort mode: `"lastAttached"`, `"name"`, or `"created"` |
|
|
100
|
+
| `confirmBeforeKill` | `true` | Show confirmation before killing sessions |
|
|
101
|
+
| `autoAttachOnCreate` | `false` | Auto-attach after creating a new session |
|
|
102
|
+
| `refreshInterval` | `0` | Auto-refresh interval in seconds (0 = disabled) |
|
|
103
|
+
| `ui.showPath` | `true` | Show session working directory |
|
|
104
|
+
| `ui.showSessionId` | `false` | Show tmux session ID |
|
|
105
|
+
| `ui.sessionNameWidth` | `20` | Session name column width (10-60) |
|
|
106
|
+
| `keybindings.*` | see defaults | Remap any keyboard shortcut |
|
|
107
|
+
|
|
108
|
+
All keybinding names: `select-up`, `select-down`, `attach`, `new`, `rename`, `kill`, `detach`, `search`, `favorite`, `favorites-filter`, `refresh`, `help`, `quit`, `batch-mark`, `batch-detach`, `batch-kill`, `detail`, `config`.
|
|
109
|
+
|
|
52
110
|
### Config mode (window management)
|
|
53
111
|
|
|
54
112
|
Press `c` on any session to enter config mode. This lets you manage windows within the selected session.
|